Struct rpds::stack::Stack

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

A persistent stack with structural sharing.

Complexity

Let n be the number of elements in the stack.

Temporal complexity

Operation	Average	Worst case
new()	Θ(1)	Θ(1)
push()	Θ(1)	Θ(1)
pop()	Θ(1)	Θ(1)
peek()	Θ(1)	Θ(1)
size()	Θ(1)	Θ(1)
clone()	Θ(1)	Θ(1)
iterator creation	Θ(1)	Θ(1)
iterator step	Θ(1)	Θ(1)
iterator full	Θ(n)	Θ(n)

Implementation details

This is a thin wrapper around a List.

Implementations

impl<T> Stack<T, ArcK>

#[must_use]pub fn new_sync() -> StackSync<T>

impl<T> Stack<T>

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

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

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

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

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

pub fn pop_mut(&mut self) -> bool

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

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

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

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

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

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

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

Returns the "default value" for a type.

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

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

Deserialize this value from the given Serde deserializer.

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

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

Formats the value using the given formatter.

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

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

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

Creates a value from an iterator.

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

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl<'a, T, P> IntoIterator for &'a Stack<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: Ord, P> Ord for Stack<T, P> where
    P: SharedPointerKind, 

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

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

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

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

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

This method tests for !=.

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

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

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

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

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

#[must_use]pub 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]pub fn gt(&self, other: &Rhs) -> bool

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

#[must_use]pub 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, P> Serialize for Stack<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.