Struct Stack

pub struct Stack<V: Copy, const N: usize> { /* private fields */ }

This is a simplest and the fastest implementation of a stack on stack, when stack elements are Copy implementing primitives.

For example, here is how a stack can be created:

use microstack::Stack;
let mut s : Stack<u64, 10> = Stack::new();
s.push(1);
s.push(2);
assert_eq!(2, s.pop());

Implementations

impl<V: Copy, const N: usize> Stack<V, N>

pub const fn new() -> Self

Make it.

The size of the stack is defined by the generic argument.

impl<'a, V: Copy + 'a, const N: usize> Stack<V, N>

pub const fn into_iter(&self) -> IntoIter<V, N>

Into-iterate them.

impl<'a, V: Copy + 'a, const N: usize> Stack<V, N>

pub const fn iter(&self) -> Iter<'_, V, N>

Iterate them.

impl<V: Copy, const N: usize> Stack<V, N>

pub fn from_vec(v: Vec<V>) -> Self

Make it from vector.

pub fn capacity(&mut self) -> usize

Get the capacity.

pub unsafe fn push_unchecked(&mut self, v: V)

Push new element into it.

Safety

It may lead to undefined behavior, if you go over the boundary.

pub fn push(&mut self, v: V)

Push new element into it.

Panics

If there is no more space in the stack, it will panic.

pub fn try_push(&mut self, v: V) -> Result<(), String>

Makes an attempt to push a new element into the stack.

If there was enough space in the stack, Ok(v) is returned, while Err is returned otherwise.

Errors

If there is not enough space in the stack, Err is returned.

pub unsafe fn pop_unchecked(&mut self) -> V

Pop a element from it.

Safety

If there are no items in the array, the result is undefined.

pub fn pop(&mut self) -> V

Pop a element from it.

Panics

If there are no items in the array, it will panic.

pub fn try_pop(&mut self) -> Result<V, String>

Pop a element from it.

Errors

If there is no more elements left, it will return None.

pub fn clear(&mut self)

Clear.

pub const fn is_empty(&self) -> bool

Is it empty.

pub const fn len(&self) -> usize

Length of it.

Trait Implementations

impl<V: Copy, const N: usize> Clone for Stack<V, N>

fn clone(&self) -> Self

Clone it.

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

Performs copy-assignment from source.

impl<V: Display + Copy, const N: usize> Debug for Stack<V, N>

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

Formats the value using the given formatter.

impl<V: Copy, const N: usize> Default for Stack<V, N>

fn default() -> Self

Make a default empty Stack.

impl<V: Display + Copy, const N: usize> Display for Stack<V, N>

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

Formats the value using the given formatter.