Struct Stack

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

Implementations

impl<T> Stack<T>

pub fn new() -> Self

Creates an empty stack.

Examples

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

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

Adds an item to the top of a stack.

Examples

use simple_stack::Stack;

let mut stack = Stack::new();
stack.push(3);

assert_eq!(stack.peek(), Some(&3));

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

Removes the top item from a stack and returns it, or None if the stack is empty.

Examples

use simple_stack::Stack;

let mut stack = Stack::new();
stack.push(3);
stack.push(7);

assert_eq!(stack.pop(), Some(7));
assert_eq!(stack.pop(), Some(3));
assert_eq!(stack.pop(), None);

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

Returns a reference to the top item of a stack, or None if the stack is empty.

Examples

use simple_stack::Stack;

let mut stack = Stack::new();

assert_eq!(stack.peek(), None);

stack.push(4);

assert_eq!(stack.peek(), Some(&4));

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

Returns a mutable reference to the top item of a stack, or None if the stack is empty.

Examples

use simple_stack::Stack;

let mut stack = Stack::new();

stack.push(11);

assert_eq!(stack.peek_mut(), Some(&mut 11));
*stack.peek_mut().unwrap() += 1;
assert_eq!(stack.peek_mut(), Some(&mut 12));

pub fn size(&self) -> usize

Returns the number of items in the stack.

Examples

use simple_stack::Stack;

let mut stack = Stack::new();

assert_eq!(stack.size(), 0);
stack.push(1);
stack.push(9);
assert_eq!(stack.size(), 2);

Trait Implementations

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

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

Formats the value using the given formatter.

impl<T> Default for Stack<T>

fn default() -> Self

Returns the “default value” for a type.