Struct ContiguousQueue

pub struct ContiguousQueue<T: Contiguous> { /* private fields */ }

Utility for queueing and assembling values in a monoidal fashion.

In particular, ContiguousQueue provides functions for queueing values and attempting to acquire adjacent values.

Implementations

impl<T: Contiguous> ContiguousQueue<T>

pub fn new() -> Self

impl<T> ContiguousQueue<T>

where T: Contiguous + Send + 'static, T::Key: Send,

pub fn find_contiguous(&self, next_value: &T) -> Option<Position<T>>

Searches for a value that is contiguous to the provided next_value.

Contiguity is stricter than mere ordering. Two values are considered contiguous if they are immediately next to each other without any gap. For example, in a series of integers, 1 and 2 are contiguous, but 1 and 3 are not.

Returns the position of the contiguous value relative to next_value if found, otherwise None.

pub fn queue(&self, value: T)

Adds the provided value to the queue.

This method is useful when a value doesn’t have an immediately contiguous counterpart in the queue. It ensures the value is stored and can be paired later when its contiguous counterpart arrives.

pub fn dequeue(&self, key: &T::Key) -> Option<T>

Removes the value with the given key from the queue.

pub fn acquire_contiguous_pair_or_queue(&self, next_value: T) -> Option<(T, T)>

Attempts to find a value contiguous to the provided next_value and pair them.

If a contiguous value is found, it returns the pair. If not, the next_value is queued for future pairing.

Trait Implementations

impl<T: Contiguous> Default for ContiguousQueue<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: Contiguous, Iter: IntoIterator<Item = T>> From<Iter> for ContiguousQueue<T>

fn from(iter: Iter) -> Self

Converts to this type from the input type.