Struct rpds::queue::Queue

pub struct Queue<T, P = RcK> where
    P: SharedPointerKind,  { /* fields omitted */ }

A persistent queue with structural sharing.

Complexity

Let n be the number of elements in the queue.

Temporal complexity

Operation	Average	Worst case
new()	Θ(1)	Θ(1)
enqueue()	Θ(1)	Θ(1)
dequeue()	Θ(1)	Θ(n)
dequeue() amortized	Θ(1)	Θ(1)
peek()	Θ(1)	Θ(1)
len()	Θ(1)	Θ(1)
clone()	Θ(1)	Θ(1)
iterator creation	Θ(1)	Θ(1)
iterator step	Θ(1)	Θ(n)
iterator full	Θ(n)	Θ(n)

Implementation details

This queue is implemented as described in Immutability in C# Part Four: An Immutable Queue.

Methods

impl<T> Queue<T>

#[must_use] pub fn new() -> Queue<T>

impl<T, P> Queue<T, P> where
    P: SharedPointerKind, 

#[must_use] pub fn new_with_ptr_kind() -> Queue<T, P>

#[must_use] pub fn peek(&self) -> Option<&T>

#[must_use] pub fn dequeue(&self) -> Option<Queue<T, P>>

pub fn dequeue_mut(&mut self) -> bool

#[must_use] pub fn enqueue(&self, v: T) -> Queue<T, P>

pub fn enqueue_mut(&mut self, v: T)

#[must_use] pub fn len(&self) -> usize

#[must_use] pub fn is_empty(&self) -> bool

#[must_use] pub fn iter(&self) -> Iter<T, P>

Trait Implementations

impl<T: Eq, P> Eq for Queue<T, P> where
    P: SharedPointerKind, 

impl<T, P> Default for Queue<T, P> where
    P: SharedPointerKind, 

fn default() -> Queue<T, P>

Returns the "default value" for a type.

impl<T, P> Clone for Queue<T, P> where
    P: SharedPointerKind, 

fn clone(&self) -> Queue<T, P>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: PartialOrd<T>, P, PO> PartialOrd<Queue<T, PO>> for Queue<T, P> where
    P: SharedPointerKind,
    PO: SharedPointerKind, 

fn partial_cmp(&self, other: &Queue<T, PO>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use] fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use] fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use] fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use] fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: Ord, P> Ord for Queue<T, P> where
    P: SharedPointerKind, 

fn cmp(&self, other: &Queue<T, P>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<T: PartialEq, P, PO> PartialEq<Queue<T, PO>> for Queue<T, P> where
    P: SharedPointerKind,
    PO: SharedPointerKind, 

fn eq(&self, other: &Queue<T, PO>) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a, T, P> IntoIterator for &'a Queue<T, P> where
    P: SharedPointerKind, 

type Item = &'a T

The type of the elements being iterated over.

type IntoIter = Iter<'a, T, P>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Iter<'a, T, P>

Creates an iterator from a value.

impl<T: Hash, P> Hash for Queue<T, P> where
    P: SharedPointerKind, 

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl<T: Display, P> Display for Queue<T, P> where
    P: SharedPointerKind, 

fn fmt(&self, fmt: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<T: Debug, P: Debug> Debug for Queue<T, P> where
    P: SharedPointerKind, 

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

Formats the value using the given formatter.

impl<T, P> FromIterator<T> for Queue<T, P> where
    P: SharedPointerKind, 

fn from_iter<I: IntoIterator<Item = T>>(into_iter: I) -> Queue<T, P>

Creates a value from an iterator.

impl<T, P> Serialize for Queue<T, P> where
    T: Serialize,
    P: SharedPointerKind, 

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl<'de, T, P> Deserialize<'de> for Queue<T, P> where
    T: Deserialize<'de>,
    P: SharedPointerKind, 

fn deserialize<D: Deserializer<'de>>(
    deserializer: D
) -> Result<Queue<T, P>, D::Error>

Deserialize this value from the given Serde deserializer.