com.simbot.component.mirai.utils.SimpleDefaultDeferred.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of component-mirai Show documentation

a simple-robot component for mirai

There is a newer version: 1.11.0-1.17-Final

/*
 *
 * Copyright (c) 2020. ForteScarlet All rights reserved.
 * Project  component-mirai
 * File     SimpleDefaultDeferred.kt
 *
 * You can contact the author through the following channels:
 *  github https://github.com/ForteScarlet
 *  gitee  https://gitee.com/ForteScarlet
 *  email  [email protected]
 *  QQ     1149159218
 *  The Mirai code is copyrighted by mamoe-mirai
 *  you can see mirai at https://github.com/mamoe/mirai
 *
 *
 */

package com.simbot.component.mirai.utils

import kotlinx.coroutines.CompletableDeferred
import kotlinx.coroutines.Deferred
import kotlinx.coroutines.Job
import net.mamoe.mirai.message.data.EmptyMessageChain
import kotlin.coroutines.CoroutineContext



/**
 *
 * @author ForteScarlet 
 * @date 2020/8/27
 *
 */
open class SimpleDefaultDeferred(private val value: T): Deferred by CompletableDeferred(null) {

    companion object SimpleDefaultDeferredKey: CoroutineContext.Key>

    /**
     * [emptySequence]
     */
    override val children: Sequence = emptySequence()

    /**
     * 总是false。因为他其中没有任何任务。
     */
    override val isActive: Boolean = false

    /**
     * 他并不会因错误或被关闭
     */
    override val isCancelled: Boolean = false

    /**
     * 他总是完成的
     */
    override val isCompleted: Boolean = true

    /**
     * A key of this coroutine context element.
     */
    override val key: CoroutineContext.Key<*> get() = SimpleDefaultDeferredKey

    /**
     * 直接返回[EmptyMessageChain]
     */
    override suspend fun await(): T = value


    /**
     * nothing to join
     */
    override suspend fun join() {}

    /**
     * Starts coroutine related to this job (if any) if it was not started yet.
     * The result `true` if this invocation actually started coroutine or `false`
     * if it was already started or completed.
     */
    override fun start(): Boolean = false
}


object EmptyMessageChainDeferred: SimpleDefaultDeferred(EmptyMessageChain)