Struct Bots 

pub struct Bots { /* private fields */ }

The bots we know about, keyed by their folded nick.

Implementations

impl Bots

pub fn new() -> Self

Know about no bots.

pub fn insert(&mut self, key: String, bot: Bot)

Record a bot the server told us about.

pub fn remove(&mut self, key: &str) -> Option<Bot>

Forget a bot.

pub fn forget(&mut self)

Forget every bot.

Which bots exist is a live view: a server replays what it knows on connect and says nothing about one that was removed while we were away.

pub fn get(&self, key: &str) -> Option<&Bot>

A bot we know about.

pub fn iter(&self) -> impl Iterator<Item = (&String, &Bot)>

Every bot, in folded nick order.

pub fn len(&self) -> usize

How many bots we know about.

pub fn is_empty(&self) -> bool

True when we know of none.

pub fn set_commands(&mut self, key: &str, commands: Vec<BotCommand>) -> bool

Record the commands a bot offers, dropping any name it is not entitled to.

A bot we have never been told about is refused outright. Accepting a command list from an arbitrary nick would let anyone put entries in the command menu, and the reference client has exactly that gap on its parallel workflow protocol.

Trait Implementations

impl Clone for Bots

fn clone(&self) -> Bots

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Bots

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

Formats the value using the given formatter.

impl Default for Bots

fn default() -> Bots

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Bots

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Bots

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 Bots

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

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.