Struct trait_based_collection::stack::Stack

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

A stack is a collection that follows the LIFO (last-in-first-out) principle. This means that elements are added to the top of the stack and removed from the top of the stack. This implementation uses a linked-based structure.

Examples

use trait_based_collection::{prelude::*, Stack};

let mut queue: Stack<u32> = Stack::new_default();
queue.add(1);
queue.add(2);
queue.add(3);

assert_eq!(queue.peek(), Some(&3));
assert_eq!(queue.remove(), Some(3));
assert_eq!(queue.remove(), Some(2));
assert_eq!(queue.remove(), Some(1));
assert_eq!(queue.remove(), None);

Trait Implementations

impl<'a, T: 'a> Collection<'a, T> for Stack<T>

fn new_default() -> Self

Creates a new Collection with a default capacity.

fn add(&mut self, value: T)

Adds an item to the Collection.

fn remove(&mut self) -> Option<T>

Removes an item from the Collection.

fn peek(&'a self) -> Option<Self::ItemRef>

Returns an immutable reference of the item that will be removed next.

fn peek_mut(&'a mut self) -> Option<Self::ItemMut>

Returns a mutable reference of the item that will be removed next.

fn get(&'a self, index: usize) -> Option<Self::ItemRef>

Returns a immutable reference to the n-th item in the Collection.

fn get_mut(&'a mut self, index: usize) -> Option<Self::ItemMut>

Returns a mutable reference to the n-th item in the Collection.

fn len(&self) -> usize

Returns the number of items in the Collection.

fn with_capacity(capacity: usize) -> Selfwhere
    Self: Sized,

Creates a new Collection with a specific capacity.

fn with_approximate_capacity(approx_capacity: usize) -> Selfwhere
    Self: Sized,

Creates a new Collection with a capacity that is at least the specified capacity.

fn clear(&mut self)

Clears all items from the Collection while keeping the capacity.

fn is_empty(&self) -> bool

Checks if the Collection is empty.

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

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.

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

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

Formats the value using the given formatter.

impl<T> Drop for Stack<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T> Extend<T> for Stack<T>

fn extend<I: IntoIterator<Item = T>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

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

fn from_iter<I: IntoIterator<Item = T>>(iter: I) -> Self

Creates a value from an iterator.

impl<T> Index<usize> for Stack<T>

type Output = T

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T> IndexMut<usize> for Stack<T>

fn index_mut(&mut self, index: usize) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<'a, T> IntoIterator for &'a Stack<T>

type Item = &'a T

The type of the elements being iterated over.

type IntoIter = StackIter<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, T> IntoIterator for &'a mut Stack<T>

type Item = &'a mut T

The type of the elements being iterated over.

type IntoIter = StackIterMut<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T> IntoIterator for Stack<T>

type Item = T

The type of the elements being iterated over.

type IntoIter = StackIntoIter<T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, T: 'a> Iterators<'a, T> for Stack<T>

type ItemRef = &'a T

The type of reference the immutable iterator (Iter) iterates over the items in the Collection. The reference is only valid for the duration of the iteration.

type ItemMut = &'a mut T

The type of mutable reference the mutable iterator (IterMut) iterates over the items in the Collection. The reference is only valid for the duration of the iteration.

type Iter = StackIter<'a, T>

Which kind of iterator is returned by iter.

type IterMut = StackIterMut<'a, T>

Which kind of iterator is returned by iter_mut.

fn iter(&'a self) -> Self::Iter

Creates an immutable iterator over the items in the Collection without consuming them.

fn iter_mut(&'a mut self) -> Self::IterMut

Creates a mutable iterator over the items in the Collection without consuming them.