Struct Intents 

pub struct Intents<A: UiAction> { /* private fields */ }

The actions drained for the current tick, consumed by the systems that answer them.

Order is the order the controls were clicked. take consumes one occurrence and reports whether it was there, which is what replaces a per-action boolean: if intents.retry becomes if intents.take(&UiAction::Retry).

Implementations

impl<A: UiAction> Intents<A>

pub fn new() -> Self

pub fn requests(&self) -> &[A]

Every pending action in order.

pub fn is_empty(&self) -> bool

pub fn len(&self) -> usize

pub fn clear(&mut self)

Forget every pending action without answering any of them.

pub fn request(&mut self, action: A)

Add one request.

pub fn extend(&mut self, actions: impl IntoIterator<Item = A>) -> usize

Add actions in argument order. Returns how many were added.

pub fn requested(&self, action: &A) -> bool

Whether an occurrence is pending, without consuming it.

pub fn count(&self, action: &A) -> usize

How many occurrences are pending.

pub fn take(&mut self, action: &A) -> bool

Consume one occurrence, reporting whether it was there.

pub fn take_matching(&mut self, predicate: impl FnMut(&A) -> bool) -> Option<A>

Consume the first occurrence matching predicate, keeping the rest.

The way to handle actions that carry a payload, e.g. a selected index: intents.take_matching(|action| matches!(action, UiAction::Pick(_))).

pub fn take_all(&mut self) -> Vec<A>

Every pending action in order, leaving the buffer empty.

Trait Implementations

impl<A: Clone + UiAction> Clone for Intents<A>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<A: Debug + UiAction> Debug for Intents<A>

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

Formats the value using the given formatter.

impl<A: Default + UiAction> Default for Intents<A>

fn default() -> Self

Returns the “default value” for a type.

impl<A: UiAction> FromIterator<A> for Intents<A>

fn from_iter<T: IntoIterator<Item = A>>(iter: T) -> Self

Creates a value from an iterator.

impl<A: PartialEq + UiAction> PartialEq for Intents<A>

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<A: PartialEq + UiAction> StructuralPartialEq for Intents<A>