Struct tbot::state::chats::Chats

pub struct Chats<S> { /* fields omitted */ }

A storage of state per chat. See the module's docs to learn how to use it.

Implementations

impl<S> Chats<S>

#[must_use]pub fn new() -> Self

Constructs a new chat storage.

#[must_use]pub fn with_capacity(capacity: usize) -> Self

Constructs a new chat storage with capacity for n chats.

pub fn chats(&self) -> impl Iterator<Item = Id> + '_

Returns an iterator over the stored chat IDs.

pub fn states(&self) -> impl Iterator<Item = &S>

Returns an iterator over the stored states.

pub fn iter(&self) -> impl Iterator<Item = (Id, &S)>

Returns an iterator over the stored chat IDs and their states.

pub fn iter_mut(&mut self) -> impl Iterator<Item = (Id, &mut S)>

Returns a mutable iterator over the stored chat IDs and their states.

#[must_use]pub fn len(&self) -> usize

Returns how many chats are stored.

#[must_use]pub fn capacity(&self) -> usize

Returns the storage's capacity.

#[must_use]pub fn is_empty(&self) -> bool

Returns true if the store is empty.

#[must_use = "use `clear` if you don't need the iterator"]pub fn drain(&mut self) -> impl Iterator<Item = (Id, S)> + '_

Clears the store, returning each stored item in an iterator.

pub fn clear(&mut self)

Clears the store.

pub fn reserve(&mut self, additional: usize)

Reserves capacity for n additional chats.

pub fn shrink_to_fit(&mut self)

Shrinks the storage to already stored chats.

#[must_use]pub fn get_by_id(&self, id: Id) -> Option<&S>

Gets a chat's state by its ID.

#[must_use]pub fn get<C>(&self, context: &C) -> Option<&S> where
    C: Message, 

Gets a chat's state, inferring its ID from the context.

#[must_use]pub fn get_mut_by_id(&mut self, id: Id) -> Option<&mut S>

Gets a mutable reference to a chat's state by its ID.

#[must_use]pub fn get_mut<C>(&mut self, context: &C) -> Option<&mut S> where
    C: Message, 

Gets a mutable reference to a chat's state, inferring its ID from the context.

#[must_use]pub fn entry_by_id(&mut self, id: Id) -> Entry<'_, Id, S>

Gets an entry for a chat's state by its ID.

#[must_use]pub fn entry<C>(&mut self, context: &C) -> Entry<'_, Id, S> where
    C: Message, 

Gets an entry for a chat's state, inferring its ID from the context.

#[must_use]pub fn has_by_id(&self, id: Id) -> bool

Checks if there's state for a chat by its ID.

#[must_use]pub fn has<C>(&self, context: &C) -> bool where
    C: Message, 

Checks if there's state for a chat, inferring its ID from the context.

pub fn insert_by_id(&mut self, id: Id, value: S) -> Option<S>

Inserts state for a chat by its ID. Returns the previous state.

pub fn insert<C>(&mut self, context: &C, value: S) -> Option<S> where
    C: Message, 

Inserts state for a chat, inferring its ID from the context. Returns the previous state.

pub fn remove_by_id(&mut self, id: Id) -> Option<S>

Removes and returns a chat's state by its ID.

pub fn remove<C>(&mut self, context: &C) -> Option<S> where
    C: Message, 

Removes and returns a chat's state, inferring its ID from the context.

pub fn retain<P>(&mut self, predicate: P) where
    P: FnMut(Id, &mut S) -> bool, 

Calls the predicate for each stored entry and deletes entries for which the predicate returns false.

Trait Implementations

impl<S: Clone> Clone for Chats<S>

fn clone(&self) -> Chats<S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S: Debug> Debug for Chats<S>

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

Formats the value using the given formatter.

impl<S> Default for Chats<S>

fn default() -> Self

Returns the "default value" for a type.

impl<'de, S> Deserialize<'de> for Chats<S> where
    S: Deserialize<'de>, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<S: Eq> Eq for Chats<S>

impl<'a, S: Copy> Extend<(Id, &'a S)> for Chats<S>

fn extend<I: IntoIterator<Item = (Id, &'a S)>>(&mut self, iterator: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<S> Extend<(Id, S)> for Chats<S>

fn extend<I: IntoIterator<Item = (Id, S)>>(&mut self, iterator: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<S> FromIterator<(Id, S)> for Chats<S>

fn from_iter<I: IntoIterator<Item = (Id, S)>>(iter: I) -> Self

Creates a value from an iterator.

impl<S> Index<Id> for Chats<S>

type Output = S

The returned type after indexing.

fn index(&self, id: Id) -> &S

Performs the indexing (container[index]) operation.

impl<S> IntoIterator for Chats<S>

type Item = (Id, S)

The type of the elements being iterated over.

type IntoIter = IntoIter<Id, S>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, S> IntoIterator for &'a Chats<S>

type Item = (Id, &'a S)

The type of the elements being iterated over.

type IntoIter = Iter<'a, S>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, S> IntoIterator for &'a mut Chats<S>

type Item = (Id, &'a mut S)

The type of the elements being iterated over.

type IntoIter = IterMut<'a, S>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<S: PartialEq> PartialEq<Chats<S>> for Chats<S>

fn eq(&self, other: &Chats<S>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Chats<S>) -> bool

This method tests for !=.

impl<S> Serialize for Chats<S> where
    S: Serialize, 

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

Serialize this value into the given Serde serializer.

impl<S> StructuralEq for Chats<S>

impl<S> StructuralPartialEq for Chats<S>