Struct relm4::factory::FactoryVecDeque

pub struct FactoryVecDeque<C: FactoryComponent> { /* private fields */ }

A container similar to VecDeque that can be used to store data associated with components that implement FactoryComponent.

To access mutable methods of the factory, create a guard using Self::guard.

Implementations

impl<C: FactoryComponent> FactoryVecDeque<C>

pub fn new(
    widget: C::ParentWidget,
    parent_sender: &Sender<C::ParentInput>
) -> Self

Creates a new FactoryVecDeque.

pub fn guard(&mut self) -> FactoryVecDequeGuard<'_, C>

Provides a FactoryVecDequeGuard that can be used to edit the factory.

The changes will be rendered on the widgets after the guard goes out of scope.

pub fn len(&self) -> usize

Returns the number of elements in the FactoryVecDeque.

pub fn is_empty(&self) -> bool

Returns true if the FactoryVecDeque is empty.

pub fn send(&self, index: usize, msg: C::Input)

Send a message to one of the elements.

pub fn broadcast(&self, msg: C::Input)where
    C::Input: Clone,

Send clone of a message to all of the elements.

pub fn get(&self, index: usize) -> Option<&C>

Tries to get an immutable reference to the model of one element.

Returns None if index is invalid.

pub fn back(&self) -> Option<&C>

Provides a reference to the model of the back element.

Returns None if the deque is empty.

pub fn front(&self) -> Option<&C>

Provides a reference to the model of the front element.

Returns None if the deque is empty.

pub const fn widget(&self) -> &C::ParentWidget

Returns the widget all components are attached to.

pub fn iter(
    &self
) -> impl Iterator<Item = &C> + DoubleEndedIterator + ExactSizeIterator + FusedIterator

Returns an iterator over the components.

pub fn from_vec(
    component_vec: Vec<C::Init>,
    widget: C::ParentWidget,
    parent_sender: &Sender<C::ParentInput>
) -> Self

Creates a FactoryVecDeque from a Vec

Trait Implementations

impl<C> Clone for FactoryVecDeque<C>where
    C: CloneableFactoryComponent + FactoryComponent,

Implements the Clone Trait for FactoryVecDeque<C> where C is Cloneable

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug + FactoryComponent> Debug for FactoryVecDeque<C>where
    C::ParentWidget: Debug,
    C::ParentInput: Debug,

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

Formats the value using the given formatter.

impl<C: FactoryComponent> Drop for FactoryVecDeque<C>

fn drop(&mut self)

Executes the destructor for this type.

impl<C: FactoryComponent> Index<usize> for FactoryVecDeque<C>

type Output = C

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.