Struct tbot::state::messages::Messages

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

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

Implementations

impl<S> Messages<S>

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

Constructs a new message storage.

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

Constructs a new message storage with capacity for n messages.

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

Returns an iterator over the stored messages.

pub fn messages_in_chat_by_id(
    &self,
    chat_id: Id
) -> impl Iterator<Item = Id> + '_

Returns an iterator over stored message IDs for a chat by its ID.

pub fn messages_in_chat<C>(&self, context: &C) -> impl Iterator<Item = Id> + '_ where
    C: Message, 

Returns an iterator over stored message IDs for a chat, which ID is inferred from the context.

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

Returns an iterator over the stored states.

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

Returns an iterator over stored states for messages in a chat by its ID.

pub fn states_in_chat<C>(&self, context: &C) -> impl Iterator<Item = &S> where
    C: Message, 

Returns an iterator over stored states for messages in a chat, which ID is inferred from the context.

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

Returns an iterator over stored messages and their states.

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

Returns an iterator over stored messages and their states in a chat by its ID.

pub fn iter_in_chat<C>(&self, context: &C) -> impl Iterator<Item = (Id, &S)> where
    C: Message, 

Returns an iterator over stored messages and their states in a chat, which ID is inferred from the context.

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

Returns a mutable iterator over the stored messages and their states.

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

Returns a mutable iterator over the stored messages and their states in a chat by its ID.

pub fn iter_mut_in_chat<C>(
    &mut self,
    context: &C
) -> impl Iterator<Item = (Id, &mut S)> where
    C: Message, 

Returns a mutable iterator over the stored messages and their states in a chat, which ID is inferred from the context.

pub fn into_iter_in_chat_by_id(
    self,
    chat_id: Id
) -> impl Iterator<Item = (Id, S)>

Returns an owning iterator over the stored messages and their states in a chat by its ID.

pub fn into_iter_in_chat<C>(self, context: &C) -> impl Iterator<Item = (Id, S)> where
    C: Message, 

Returns an owning iterator over the stored messages and their states in a chat, which ID is inferred from the context.

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

Returns how many messages are stored.

#[must_use]pub fn len_in_chat_by_id(&self, chat_id: Id) -> usize

Returns how many messages from a chat are stored.

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

Returns how many messages from a chat, which ID is inferred from the context, 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]pub fn is_empty_in_chat_by_id(&self, chat_id: Id) -> bool

Returns if the store does not have messages from a chat.

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

Returns if the store does not have messages from a chat, inferring its ID from the context.

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

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

pub fn clear(&mut self)

Clears the store.

pub fn clear_in_chat_by_id(&mut self, chat_id: Id)

Deletes state for all messages from a chat.

pub fn clear_in_chat<C>(&mut self, context: &C) where
    C: Message, 

Deletes state for all messages from a chat, inferring its ID from the context.

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

Reserves capacity for n additional messages.

pub fn shrink_to_fit(&mut self)

Shrinks the capacity to already stored messages.

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

Gets a message's state by its ID.

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

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

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

Gets a mutable reference to a message'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 message's state, inferring its ID from the context.

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

Gets an entry to a message's state by its ID.

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

Gets an entry to a message's state, inferring its ID from the context.

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

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

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

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

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

Inserts state for a message 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 message, inferring its ID from the context. Returns the previous state.

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

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

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

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

pub fn retain<P>(&mut self, predicate: P) where
    P: FnMut(MessageId, &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 Messages<S>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S: Debug> Debug for Messages<S>

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

Formats the value using the given formatter.

impl<S> Default for Messages<S>

fn default() -> Self

Returns the "default value" for a type.

impl<'de, S> Deserialize<'de> for Messages<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 Messages<S>

impl<'a, S: Copy> Extend<(MessageId, &'a S)> for Messages<S>

fn extend<I: IntoIterator<Item = (MessageId, &'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<(MessageId, S)> for Messages<S>

fn extend<I: IntoIterator<Item = (MessageId, 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<(MessageId, S)> for Messages<S>

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

Creates a value from an iterator.

impl<S> Index<MessageId> for Messages<S>

type Output = S

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<S> IntoIterator for Messages<S>

type Item = (MessageId, S)

The type of the elements being iterated over.

type IntoIter = IntoIter<MessageId, 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 Messages<S>

type Item = (MessageId, &'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 Messages<S>

type Item = (MessageId, &'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<Messages<S>> for Messages<S>

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

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

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

This method tests for !=.

impl<S> Serialize for Messages<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 Messages<S>

impl<S> StructuralPartialEq for Messages<S>