//! Types for the *m.tag* event.

use std::collections::HashMap;

event! {
    /// Informs the client of tags on a room.
    pub struct TagEvent(TagEventContent) {}
}

/// The payload of a `TagEvent`.
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct TagEventContent {
    /// A map of tag names to tag info.
    pub tags: HashMap<String, TagInfo>,
}

/// Information about a tag.
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct TagInfo {
    /// Value to use for lexicographically ordering rooms with this tag.
    #[serde(skip_serializing_if="Option::is_none")]
    pub order: Option<String>,
}