/*
 * Copyright 2020 Mamoe Technologies and contributors.
 *
 * 此源代码的使用受 GNU AFFERO GENERAL PUBLIC LICENSE version 3 许可证的约束, 可以在以下链接找到该许可证.
 * Use of this source code is governed by the GNU AGPLv3 license that can be found through the following link.
 *
 * https://github.com/mamoe/mirai/blob/master/LICENSE
 */

package net.mamoe.mirai.message.code

import net.mamoe.mirai.message.data.*
import net.mamoe.mirai.utils.SinceMirai

/**
 * 可以使用 mirai 码表示的 [Message] 类型.
 *
 * 使用 `mirai-serialization` 中 `String.parseMiraiCode()` 转回 [Message].
 *
 * ## 规范
 * 可在 [mirai-code-specification.md](https://github.com/mamoe/mirai/blob/dev/docs/mirai-code-specification.md) 查看 mirai 码规范.
 *
 * @suppress 警告: 此 API 可能在任何时刻被改变
 *
 * @see At
 * @see AtAll
 * @see VipFace
 * @see Face
 * @see Image
 * @see FlashImage
 * @see PokeMessage
 */
@SinceMirai("1.1.0")
public interface CodableMessage : Message {
    /**
     * 转换为 mirai 码.
     *
     * @suppress 警告: 此 API 可能在任何时刻被改变
     */
    public fun toMiraiCode(): String = this.toString()
}