Struct Stack

Source

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

Expand description

A stack data structure.

This structure implements a simple stack where elements of type T are pushed and popped according to the Last-In-First-Out (LIFO) principle. The stack has a fixed size of 100 elements.

Implementations§

Source §

impl<T> Stack<T>

Source

pub fn new() -> Self

Creates a new, empty Stack.

§Examples

use dsa::data_structures::stack::Stack; 
let stack: Stack<i32> = Stack::new();
assert!(stack.is_empty());

Source

pub fn push(&mut self, value: T) -> Result<(), &str>

Pushes a value onto the Stack.

§Examples

use dsa::data_structures::stack::Stack;
let mut stack = Stack::new();
stack.push(10).unwrap();
stack.push(20).unwrap();
assert_eq!(stack.peek(), Some(&20));
assert_eq!(stack.size(), 2);

§Parameters

value: A T generic value that will be pushed onto the top of this Stack

§Returns

A Result object that return an Err if this Stack is full, otherwise an empty Ok(())

Source

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

Pops a value from the Stack.

§Examples

 use dsa::data_structures::stack::Stack;
 let mut stack: Stack<i32> = Stack::new();
 stack.push(10).unwrap();
 stack.push(20).unwrap();
 stack.pop();
 assert_eq!(stack.pop(), Some(10));

§Returns

An optional T generic that represents the topmost value that has been removed from this Stack

Source

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

Returns a reference to the top element without removing it.

§Examples

 use dsa::data_structures::stack::Stack;
 let mut stack: Stack<i32> = Stack::new();
 stack.push(10).unwrap();
 stack.push(20).unwrap();
 stack.pop();
 assert_eq!(stack.peek(), Some(&10));

§Returns

The topmost value of this Stack as an optional T generic reference

Source

pub fn is_empty(&self) -> bool

Checks if the Stack is empty.

§Examples

use dsa::data_structures::stack::Stack;
 
let mut stack: Stack<u32> = Stack::new();
assert!(stack.is_empty());

§Returns

A bool value determining whether this Stack is empty

Source

pub fn size(&self) -> isize

Get the size of this Stack

§Examples

use dsa::data_structures::stack::Stack;
let mut stack: Stack<i32> = Stack::new();
stack.push(10).unwrap(); 
stack.push(20).unwrap();
stack.pop();
assert_eq!(stack.size(), 1);