COUNT_EMPTY

const val COUNT_EMPTY: Int = 0(source)

xxxCount 相关API中使用的常量信息,代表此API得到的结果为空。

通常用于在源码中明确表示此API得到的结果始终为空,常量本身不可用于直接作为判断比较。 此常量面向 SocialRelationsContainer 相关类型的实现者而不是使用者。

正例

guildCount 为例,某 Bot 的实现者在源码中宣告 guildCount 不被支持,始终得到 0:

class SomeBotImpl : Bot {
override suspend fun guildCount(): Int = SocialRelationsContainer.COUNT_EMPTY
// 需要再配套真正而全面的说明,比如标记 @Deprecated 注解和明确的文档注释等。
}

反例

if (bot.guildCount() == SocialRelationsContainer.COUNT_EMPTY) {
// 错误的认为 bot.guildCount 会始终得到 0
}