Struct Model 

pub struct Model {
    pub me: LocalUser,
    /* private fields */
}

Everything the connection knows.

Fields

me: LocalUser

Who we are.

Implementations

impl Model

pub fn with_retention(retention: usize) -> Self

An empty model with this retention limit per target.

pub fn next_message_key(&mut self, time_ms: u64) -> MessageKey

The next sequence number, which breaks timestamp ties in arrival order.

pub fn channel(&self, key: &CaseFolded) -> Option<&Channel>

A channel by name, folded with the server’s casemapping.

pub fn channel_or_insert(&mut self, key: CaseFolded, name: &str) -> &mut Channel

A channel, created if we have not seen it.

pub fn channels_mut(&mut self) -> IterMut<'_, CaseFolded, Channel>

Every channel, for changing what is in them.

pub fn channel_mut(&mut self, key: &CaseFolded) -> Option<&mut Channel>

A channel we already know, for changing what is in it.

pub fn remove_channel(&mut self, key: &CaseFolded) -> Option<Channel>

Forget a channel, which is what leaving one means.

pub fn channels(&self) -> Iter<'_, CaseFolded, Channel>

Every channel, in folded name order.

pub fn conversation(&self, key: &CaseFolded) -> Option<&Conversation>

A private conversation.

pub fn conversation_or_insert( &mut self, key: CaseFolded, nick: &str, ) -> &mut Conversation

A private conversation, created if we have not seen it.

pub fn set_typing( &mut self, target: &CaseFolded, who: CaseFolded, typing: bool, ) -> bool

Record that someone started or stopped composing a message somewhere.

Returns true when this changed anything, so a caller does not report a state that already held. A typing indicator repeats on a timer, and re-reporting each repeat makes it flicker.

pub fn person(&self, key: &CaseFolded) -> Option<&Person>

Someone we know about.

pub fn person_or_insert(&mut self, key: CaseFolded, nick: &str) -> &mut Person

Someone we know about, remembered from now on if we did not already.

pub fn person_mut(&mut self, key: &CaseFolded) -> Option<&mut Person>

Someone we already know, for changing what we hold about them.

pub fn whois(&self, key: &CaseFolded) -> Option<&Whois>

What the last WHOIS said about someone.

pub fn whois_or_insert(&mut self, key: CaseFolded, nick: &str) -> &mut Whois

The record a WHOIS reply is filling in.

A record whose 318 already arrived is replaced rather than added to, because the numerics a second reply leaves out are the ones that stopped being true: an operator who deopered sends no 313 to say so.

pub fn whois_records(&self) -> Iter<'_, CaseFolded, Whois>

Every WHOIS record held, in folded nick order.

pub fn whois_mut(&mut self, key: &CaseFolded) -> Option<&mut Whois>

A WHOIS record we already hold, for filling in as its numerics arrive.

pub fn conversation_mut( &mut self, key: &CaseFolded, ) -> Option<&mut Conversation>

A private conversation we already know, for changing what is in it.

pub fn conversations(&self) -> Iter<'_, CaseFolded, Conversation>

Every private conversation.

pub fn rename(&mut self, casemapping: Casemapping, from: &str, to: &str)

Rename someone everywhere they appear, which is what a NICK means.

Membership is keyed by the folded nick, so a rename has to move every entry rather than edit one field, and a fold that only lowercases ASCII would leave duplicates behind on any server that folds the bracket alphabet.

pub fn rename_channel( &mut self, casemapping: Casemapping, from: &str, to: &str, ) -> bool

Move a channel to a new name, keeping everything in it. Returns whether we were in it.

The map is keyed by the folded name, so a rename has to move the entry: editing the name in place leaves every later lookup of the new name missing a channel we are still sitting in.

pub fn forget_strangers(&mut self)

Forget anyone we no longer share a channel or a conversation with.

Without this a long session accumulates one permanent record per nick it has ever seen, which a busy channel supplies for free.

pub fn forget_whois(&mut self)

Forget every WHOIS record.

A record describes someone as the server saw them on one connection. A reply cut short by a dead link would otherwise leave fields behind for the next connection to merge into.

pub fn remove_everywhere(&mut self, who: &CaseFolded) -> Vec<CaseFolded>

Remove someone from every channel, which is what a QUIT means. Returns where they were.

Trait Implementations

impl Clone for Model

fn clone(&self) -> Model

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Model

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

Formats the value using the given formatter.

impl Default for Model

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Model

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Model

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 Model

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

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.