Struct Stack

pub struct Stack {
    pub vec: Vec<u8>,
}

A stack.

A stack is a kind of memory that can only be manipulated by pushing (appending) an element, or by popping (removing) the last element, like a stack of plates, which makes it a **first in, last out (LOFI) ** data type.

Fields

vec: Vec<u8>

The data storage of the stack.

Implementations

impl Stack

pub fn total_space(&self) -> usize

Returns the capacity of the stack (how big it is) in bytes.

pub fn used_space(&self) -> usize

Returns how much space of the stack has been used in bytes.

pub fn space_left(&self) -> usize

Returns how much space is left of the stack in bytes.

pub unsafe fn set_used_space(&mut self, new_len: usize)

Sets how much space is used of the stack.

Safety

Any value of type u8 can’t possibly be invalid.

The caller must guarantee that new_len doesn’t exceed the capacity of the stack.

pub fn push_byte(&mut self, byte: u8) -> Result<(), StackOverflow>

Pushes a byte onto the Stack.

Errors

Returns StackOverflow if the stack has no more space (capacity == length).

pub fn pop_byte(&mut self) -> Option<u8>

Pops a byte from the Stack.

Returns None if there are no bytes on the Stack.

pub fn push_bytes(&mut self, bytes: &[u8]) -> Result<(), StackOverflow>

Copies a slice onto the Stack.

This is done by allocating bytes bytes and writing the slice onto the buffer using ptr::copy

Errors

Returns StackOverflow and doesn’t allocate if the stack doesn’t have enough space left.

pub fn alloc(&mut self, bytes: usize) -> Result<(), StackOverflow>

Pushes bytes bytes onto the Stack.

Errors

Returns StackOverflow and doesn’t allocate if the bytes don’t fit on the stack (bytes > capacity - length).

pub unsafe fn dealloc(&mut self, bytes: usize) -> Result<(), StackOverflow>

Pops bytes bytes from the Stack.

Pops the amount of bytes specified and returns a slice of them.

Errors

Returns StackOverflow if there is not enough space.

Safety

The caller must guarantee that the slice isn’t used when the Stack is pushed onto again to prevent race conditions.

pub fn pop_u16(&mut self) -> Option<u16>

Pops a 16-bit big endian unsigned integer from the stack.

pub fn pop_u32(&mut self) -> Option<u32>

Pops a 32-bit big endian unsigned integer from the stack.

pub fn pop_u64(&mut self) -> Option<u64>

Pops a 64-bit big endian unsigned integer from the stack.

Trait Implementations

impl Clone for Stack

fn clone(&self) -> Stack

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Stack

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

Formats the value using the given formatter.

impl Default for Stack

fn default() -> Self

Returns the “default value” for a type.