Struct Stack 

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

A LIFO stack backed by a Vec.

Elements are pushed and popped from the top of the stack. All operations are O(1) amortized.

Examples

use graph_collections::Stack;
let mut s: Stack<i32> = Stack::new();
s.push(1);
s.push(2);
assert_eq!(s.pop(), Some(2));
assert_eq!(s.peek(), Some(&1));
assert_eq!(s.len(), 1);
assert!(!s.is_empty());

Implementations

impl<T> Stack<T>

pub fn new() -> Stack<T>

Creates a new empty stack.

Examples

use graph_collections::Stack;
let s: Stack<i32> = Stack::new();
assert!(s.is_empty());

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

Pushes a value onto the top of the stack.

Examples

use graph_collections::Stack;
let mut s: Stack<i32> = Stack::new();
s.push(10);
assert_eq!(s.peek(), Some(&10));

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

Removes and returns the top value, or None if the stack is empty.

Examples

use graph_collections::Stack;
let mut s: Stack<i32> = Stack::new();
s.push(1);
s.push(2);
assert_eq!(s.pop(), Some(2));
assert_eq!(s.pop(), Some(1));
assert_eq!(s.pop(), None);

pub fn peek(&self) -> Option<&T>

Returns a reference to the top value without removing it, or None if the stack is empty.

Examples

use graph_collections::Stack;
let mut s: Stack<i32> = Stack::new();
s.push(5);
assert_eq!(s.peek(), Some(&5));
assert_eq!(s.len(), 1); // peek does not remove

pub fn is_empty(&self) -> bool

Returns true if the stack contains no elements.

Examples

use graph_collections::Stack;
let mut s: Stack<i32> = Stack::new();
assert!(s.is_empty());
s.push(1);
assert!(!s.is_empty());

pub fn len(&self) -> usize

Returns the number of elements in the stack.

Examples

use graph_collections::Stack;
let mut s: Stack<i32> = Stack::new();
s.push(1);
s.push(2);
assert_eq!(s.len(), 2);

Trait Implementations

impl<T> Clone for Stack<T>

where T: Clone,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Stack<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> Default for Stack<T>

fn default() -> Stack<T>

Returns the “default value” for a type.

impl<T> From<Vec<T>> for Stack<T>

fn from(data: Vec<T>) -> Stack<T>

Converts to this type from the input type.

impl<T> FromIterator<T> for Stack<T>

fn from_iter<I>(iter: I) -> Stack<T>

where I: IntoIterator<Item = T>,

Creates a value from an iterator.

impl<T> IntoIterator for Stack<T>

type Item = T

The type of the elements being iterated over.

type IntoIter = IntoIter<T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> IntoIter<T>

Creates an iterator from a value.

impl<T> PartialEq for Stack<T>

where T: PartialEq,

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> StructuralPartialEq for Stack<T>