Struct Snapshot 

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

A representation of the results of a Nucleo worker after finishing a tick.

Implementations

impl<T: Sync + Send + 'static> Snapshot<T>

pub fn item_count(&self) -> u32

Returns that total number of items

pub fn pattern(&self) -> &MultiPattern

Returns the pattern which items were matched against

pub fn matched_item_count(&self) -> u32

Returns that number of items that matched the pattern

pub fn matched_items( &self, range: impl RangeBounds<u32>, ) -> impl ExactSizeIterator<Item = Item<'_, T>> + DoubleEndedIterator + '_

Returns an iterator over the items that correspond to a subrange of all the matches in this snapshot.

Panics

Panics if range has a range bound that is larger than the matched item count

pub fn get_item(&self, index: u32) -> Option<Item<'_, T>>

Returns a reference to the item at the given index.

Returns None if the given index is not initialized. This function is only guarteed to return Some for item indices that can be found in the matches of this struct. Both smaller and larger indices may return None.

pub unsafe fn get_item_unchecked(&self, index: u32) -> Item<'_, T>

Returns a reference to the item at the given index.

Safety

Item at index must be initialized. That means you must have observed a match with the corresponding index in this exact snapshot. Observing a higher index is not enough as item indices can be non-contigously initialized

pub fn get_detached_item(&self, index: u32) -> Option<DetachedItem<T>>

Returns the detached item at the given index.

pub unsafe fn get_detached_item_unchecked(&self, index: u32) -> DetachedItem<T>

Returns the detached item at the given index without checking that the index is valid.

Safety

Item at index must be initialized. That means you must have observed push returning this value or get returning Some for this value. Just because a later index is initialized doesn’t mean that this index is initialized

pub fn matches(&self) -> &[Match]

Returns the matches corresponding to this snapshot.

pub fn get_matched_item(&self, n: u32) -> Option<Item<'_, T>>

A convenience function to return the Item corresponding to the nth match.

Returns None if n is greater than or equal to the match count.

pub fn get_matched_detached_item(&self, n: u32) -> Option<DetachedItem<T>>

A convenience function to return the DetachedItem corresponding to the nth match.

Returns None if n is greater than or equal to the match count.