Struct settings_inspect_utils::managed_inspect_queue::ManagedInspectQueue

pub struct ManagedInspectQueue<V> { /* private fields */ }

A queue that wraps an inspect node and attaches all inserted values to the node.

This class can either be explicitly given an inspect node through ManagedInspectQueue::with_node or can create its own inspect node when included in a struct that derives Inspect or when [ManagedInspectQueue::with_inspect] is called. ManagedInspectQueue will only keep the last [size_limit] items.

Implementations

impl<V> ManagedInspectQueue<V>

where for<'a> &'a mut V: Inspect, V: Debug + Default,

pub fn new(size_limit: usize) -> Self

Creates a new ManagedInspectQueue with a default node. This gives the parent the option to call with_inspect itself instead of passing a node into with_node.

pub fn with_node(node: Node, size_limit: usize) -> Self

Creates a new ManagedInspectQueue that attaches inserted values to the given node. A size limit of 0 indicates an unlimited length.

pub fn iter_mut(&mut self) -> IterMut<'_, V>

Returns a mutable iterator for the underlying queue.

pub fn items_mut(&mut self) -> &mut VecDeque<V>

Returns a mutable reference to the underlying queue. Items should be inserted with this reference.

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

where F: FnMut(&V) -> bool,

Filters the queue by the condition function [f].

pub fn inspect_node(&self) -> &Node

Returns a reference to the ManagedInspectQueue’s node.

pub fn push(&mut self, key: &str, item: V)

Inserts the given value into the queue and attaches it to the inspect tree. If the new size of the queue is over capacity, the oldest value is removed.

Trait Implementations

impl<V: Default> Default for ManagedInspectQueue<V>

fn default() -> ManagedInspectQueue<V>

Returns the “default value” for a type.

impl<V> Inspect for &mut ManagedInspectQueue<V>

where for<'a> &'a mut V: Inspect,

fn iattach( self, parent: &Node, name: impl AsRef<str> ) -> Result<(), AttachError>

Attaches self to the inspect tree, under parent[name]. Note that: