Struct Channel 

pub struct Channel {
    pub name: String,
    pub topic: Option<String>,
    pub topic_by: Option<String>,
    pub modes: BTreeMap<char, Option<String>>,
    pub members: BTreeMap<CaseFolded, Membership>,
    pub log: MessageLog,
    pub unread: u32,
    pub mentions: u32,
    pub metadata: BTreeMap<String, String>,
    pub read_marker: Option<String>,
    pub typing: BTreeSet<CaseFolded>,
    pub named_modes: BTreeMap<String, Option<String>>,
}

A channel we are in.

Fields

name: String

The name as the server spells it.

topic: Option<String>

The topic, when one is set.

topic_by: Option<String>

Who set the topic and when.

modes: BTreeMap<char, Option<String>>

Channel modes currently set, with their arguments.

members: BTreeMap<CaseFolded, Membership>

Who is in it.

log: MessageLog

What was said.

unread: u32

Messages since the last read marker.

mentions: u32

Unread messages that mention us.

metadata: BTreeMap<String, String>

Metadata the server holds, such as display-name, color, avatar and bot.

These are plain draft/metadata-2 keys with no vendor prefix, despite everything else Obby adds being namespaced.

read_marker: Option<String>

The read marker timestamp the server last confirmed.

typing: BTreeSet<CaseFolded>

Who is composing a message here right now.

named_modes: BTreeMap<String, Option<String>>

Modes by their name rather than their letter, from draft/named-modes.

A letter means nothing without the server telling you what it does, and two servers spell the same feature differently. The names are stable, so this is what a user interface should show and what a setting should be keyed by.

Trait Implementations

impl Clone for Channel

fn clone(&self) -> Channel

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Channel

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Channel

fn default() -> Channel

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Channel

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Channel

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TS for Channel

const DOCS: Option<&'static str>

JSDoc comment to describe this type in TypeScript - when TS is derived, docs are automatically read from your doc comments or #[doc = ".."] attributes

type WithoutGenerics = Channel

If this type does not have generic parameters, then WithoutGenerics should just be Self. If the type does have generic parameters, then all generic parameters must be replaced with a dummy type, e.g ts_rs::Dummy or (). The only requirement for these dummy types is that EXPORT_TO must be None.

fn ident() -> String

Identifier of this type, excluding generic parameters.

fn name() -> String

Name of this type in TypeScript, including generic parameters

fn decl_concrete() -> String

Declaration of this type using the supplied generic arguments. The resulting TypeScript definition will not be generic. For that, see TS::decl(). If this type is not generic, then this function is equivalent to TS::decl().

fn decl() -> String

Declaration of this type, e.g. type User = { user_id: number, ... }. This function will panic if the type has no declaration.

fn inline() -> String

Formats this types definition in TypeScript, e.g { user_id: number }. This function will panic if the type cannot be inlined.

fn inline_flattened() -> String

Flatten a type declaration.
This function will panic if the type cannot be flattened.

fn visit_generics(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all type parameters of this type.

fn output_path() -> Option<&'static Path>

Returns the output path to where T should be exported.
The returned path does not include the base directory from TS_RS_EXPORT_DIR.

fn visit_dependencies(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all dependency of this type.

fn dependencies() -> Vec<Dependency>

where Self: 'static,

Resolves all dependencies of this type recursively.

fn export() -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem. To export this type together with all of its dependencies, use [TS::export_all].

fn export_all() -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem, together with all of its dependencies.
To export only this type, without its dependencies, use [TS::export].

fn export_all_to(out_dir: impl AsRef<Path>) -> Result<(), ExportError>

where Self: 'static,

Manually export this type into the given directory, together with all of its dependencies.
To export only this type, without its dependencies, use [TS::export].

fn export_to_string() -> Result<String, ExportError>

where Self: 'static,

Manually generate bindings for this type, returning a String.
This function does not format the output, even if the format feature is enabled.

fn default_output_path() -> Option<PathBuf>

Returns the output path to where T should be exported.