Enum Change 

#[non_exhaustive]
pub enum Change {
    MessageAdded {
        target: String,
        key: MessageKey,
    },
    ChannelJoined {
        channel: String,
    },
    ChannelParted {
        channel: String,
    },
    ChannelMembersChanged {
        channel: String,
    },
    ChannelTopicChanged {
        channel: String,
    },
    NickChanged {
        from: String,
        to: String,
    },
    ChannelModesChanged {
        channel: String,
    },
    ReadMarkerMoved {
        target: String,
    },
    MessageReacted {
        target: String,
        msgid: String,
    },
    MessageRedacted {
        target: String,
        msgid: String,
    },
    MetadataChanged {
        target: String,
        key: String,
    },
    WhoisReceived {
        nick: String,
    },
    ChannelRenamed {
        from: String,
        to: String,
    },
}

What changed, for a host that wants to react without diffing the whole model.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

MessageAdded

A message landed in a channel or a conversation.

Fields

target: String

The channel or nick it belongs to, as the server spells it.

key: MessageKey

Where it sits in that target’s log.

ChannelJoined

We joined a channel.

Fields

channel: String

The channel.

ChannelParted

We left a channel, whether by choice or by being removed.

Fields

channel: String

The channel.

ChannelMembersChanged

A channel’s member list changed.

Fields

channel: String

The channel.

ChannelTopicChanged

A channel’s topic changed.

Fields

channel: String

The channel.

NickChanged

Someone changed nick, possibly us.

Fields

from: String

What they were called.

to: String

What they are called now.

ChannelModesChanged

A channel’s modes changed.

Fields

channel: String

The channel.

ReadMarkerMoved

The server confirmed how far we have read, so the unread counts moved.

Fields

target: String

The channel or person.

MessageReacted

A message gained or lost a reaction.

Fields

target: String

Where the message is.

msgid: String

The message reacted to.

MessageRedacted

A message was deleted.

Fields

target: String

Where the message was.

msgid: String

The message deleted.

MetadataChanged

A metadata key changed on a person, a channel, or us.

Fields

target: String

Whose metadata changed.

key: String

The key that changed.

WhoisReceived

A WHOIS reply finished. The whole record is in the model, under the folded nick.

Fields

nick: String

Who it describes.

ChannelRenamed

A channel changed its name and is the same channel, with the same people and messages.

Fields

from: String

What it was called.

to: String

What it is called now.

Trait Implementations

impl Clone for Change

fn clone(&self) -> Change

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Change

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Change

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Change

impl PartialEq for Change

fn eq(&self, other: &Change) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Change

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Change

impl TS for Change

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 = Change

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.