Messages

Struct Messages 

Source
pub struct Messages<M: Message> { /* private fields */ }
Expand description

Container for managing messages of a specific type.

This struct maintains separate lists for messages from the current and previous frames.

Implementations§

Source§

impl<M: Message> Messages<M>

Source

pub const fn new() -> Self

Creates a new Messages container.

Source

pub fn send(&mut self, message: M) -> MessageId<M>

Sends a new message, assigning it a unique MessageId.

The message is added to the current_messages list.

§Arguments
  • message - The message to be sent.
§Returns

A MessageId uniquely identifying the sent message.

Source

pub fn swap(&mut self)

Swaps the current and previous frame message lists.

This should be called at the start of each new frame (update) to transition messages appropriately.

Source

pub fn iter_current(&self) -> MessagesIterator<'_, M>

Returns an iterator over the current frame’s messages.

Source

pub fn iter_previous(&self) -> MessagesIterator<'_, M>

Returns an iterator over the previous frame’s messages.

Source

pub fn len_current(&self) -> usize

Returns the number of messages in the current frame.

Source

pub fn len_previous(&self) -> usize

Returns the number of messages in the previous frame.

Source

pub fn is_empty_current(&self) -> bool

Checks if there are no messages in the current frame.

Source

pub fn is_empty_previous(&self) -> bool

Checks if there are no messages in the previous frame.

Trait Implementations§

Source§

impl<M: Debug + Message> Debug for Messages<M>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<M: Default + Message> Default for Messages<M>

Source§

fn default() -> Messages<M>

Returns the “default value” for a type. Read more
Source§

impl<M: Message> MessageContainer for Messages<M>

Source§

fn swap(&mut self)

Swaps the current and previous frame message lists.
Source§

fn as_any(&self) -> &dyn Any

Provides a reference to the container as Any for downcasting.
Source§

fn as_any_mut(&mut self) -> &mut dyn Any

Provides a mutable reference to the container as Any for downcasting.
Source§

impl<M: Message> Resource for Messages<M>

Auto Trait Implementations§

§

impl<M> Freeze for Messages<M>

§

impl<M> RefUnwindSafe for Messages<M>
where M: RefUnwindSafe,

§

impl<M> Send for Messages<M>

§

impl<M> Sync for Messages<M>

§

impl<M> Unpin for Messages<M>
where M: Unpin,

§

impl<M> UnwindSafe for Messages<M>
where M: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more