Struct Stack

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

A growable and shrinkable stack array type.

Example

use hay::Stack;
let mut stack = Stack::new();
stack.push(1);
stack.push(2);
assert_eq!(stack.len(), 2);
assert_eq!(stack.pop(), Some(2));
assert_eq!(stack.pop(), Some(1));
assert_eq!(stack.pop(), None);

~24 bytes on the stack!!!

Implementations

impl<T> Stack<T>

pub const fn new() -> Self

Constructs a new, empty Stack<T>.

The stack will not allocate until elements are pushed onto it.

Example

use hay::Stack;
let mut stack: Stack<i32> = Stack::<i32>::new();

pub fn push(&mut self, value: T)

Appends an element to the top of the stack.

Panics

Panics if the new capacity exceeds isize::MAX.

Example

use hay::Stack;
let mut stack = Stack::new();
stack.push(1);
assert_eq!(stack.pop(), Some(1));

pub fn pop(&mut self) -> Option<T>

Removes the element at the top of the stack and returns it, or None if it is empty.

Example

use hay::Stack;
let mut stack = Stack::new();
stack.push(1);
assert_eq!(stack.pop(), Some(1));

pub fn clear(&mut self)

Clears the stack, popping all values.

Note that this method has no effect on the allocated capacity of the stack.

Example

use hay::Stack;
let mut stack = Stack::new();
stack.push(1);
stack.push(2);
stack.push(3);
stack.clear();
assert_eq!(stack.pop(), None);

pub fn len(&self) -> usize

Returns the number of elements on the stack, also referred to as it’s ‘length’.

Example

use hay::Stack;
let mut stack = Stack::new();
stack.push(1);
stack.push(2);
assert_eq!(stack.len(), 2);

pub const fn as_vec(&self) -> &Vec<T>

Extracts a vector containing the entire stack.

Example

use hay::Stack;
let mut stack = Stack::new();
stack.push(0);
stack.push(1);
stack.push(2);
let slice = unsafe { stack.as_vec().as_slice() };
assert_eq!(slice, &[0, 1, 2]);

pub fn as_mut_vec(&mut self) -> &mut Vec<T>

Extracts a mutable vector containing the entire stack.

Example

use hay::Stack;
let mut stack = Stack::new();
stack.push(2);
unsafe { stack.as_mut_vec().insert(0, 1) };
assert_eq!(stack.len(), 2);
assert_eq!(stack.pop(), Some(2));
assert_eq!(stack.pop(), Some(1));
assert_eq!(stack.pop(), None);

Trait Implementations

impl<T: Clone> Clone for Stack<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Stack<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for Stack<T>

fn default() -> Stack<T>

Returns the “default value” for a type.

impl<T: Hash> Hash for Stack<T>

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: Ord> Ord for Stack<T>

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq for Stack<T>

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: PartialOrd> PartialOrd for Stack<T>

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

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

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

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

impl<T: Eq> Eq for Stack<T>

impl<T> StructuralPartialEq for Stack<T>