Struct WatchList 

pub struct WatchList { /* private fields */ }

Who we are watching, and whether each is online.

Implementations

impl WatchList

pub fn new() -> Self

Watch nobody.

pub fn watch(&mut self, folded: impl IntoIterator<Item = CaseFolded>)

Note that we asked to watch these.

pub fn unwatch(&mut self, folded: &[CaseFolded])

Note that we asked to stop watching these.

pub fn clear(&mut self)

Forget everyone, which is what MONITOR C does.

pub fn mark_online(&mut self, folded: CaseFolded)

Record that someone is online.

pub fn mark_offline(&mut self, folded: &CaseFolded)

Record that someone is offline.

pub fn is_watching(&self, folded: &CaseFolded) -> bool

True when we are watching this nick.

pub fn is_online(&self, folded: &CaseFolded) -> bool

True when this nick is online, as far as the server has told us.

pub fn watched(&self) -> impl Iterator<Item = &CaseFolded>

Everyone we are watching, so a reconnect can ask for them again.

pub fn len(&self) -> usize

How many we are watching.

pub fn is_empty(&self) -> bool

True when we are watching nobody.

pub fn forget_presence(&mut self)

Nobody is online until the server says so, which is what a dropped link resets us to.

Trait Implementations

impl Clone for WatchList

fn clone(&self) -> WatchList

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WatchList

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

Formats the value using the given formatter.

impl Default for WatchList

fn default() -> WatchList

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for WatchList

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for WatchList

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 WatchList

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

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.