Struct UseQueueHandle

pub struct UseQueueHandle<T> { /* private fields */ }

State handle for the use_queue hook.

Implementations

impl<T> UseQueueHandle<T>

pub fn current(&self) -> Ref<'_, VecDeque<T>>

Get immutable ref to the queue.

Panics

Panics if the value is currently mutably borrowed

pub fn set(&self, queue: VecDeque<T>)

Set the queue.

pub fn push_back(&self, value: T)

where T: Eq + Hash,

Appends an element to the back of the queue.

pub fn pop_front(&self) -> Option<T>

where T: Eq + Hash,

Removes the first element and returns it, or None if the queue is empty.

pub fn retain<F>(&self, f: F)

where T: Eq + Hash, F: FnMut(&T) -> bool,

Retains only the elements specified by the predicate.

pub fn clear(&self)

Clears the queue, removing all values.

Trait Implementations

impl<T> Clone for UseQueueHandle<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> PartialEq for UseQueueHandle<T>

where T: Eq + Hash,

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.