Struct nstack::NStack

pub struct NStack<T, A, H>(_, _)
 where
    T: Content<H>,
    Self: Compound<H>,
    H: ByteHash;

A stack datastructure with indexed lookup.

Implementations

impl<T, A, H> NStack<T, A, H> where
    T: Content<H>,
    A: Content<H> + Annotation<T, H>,
    H: ByteHash, 

pub fn new() -> Self

Creates a new empty NStack

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

Pushes a new element onto the stack

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

Pop an element off the stack.

Returns the popped element, if any.

pub fn get<U>(&self, idx: U) -> Result<Option<Branch<Self, H>>> where
    U: Counter,
    Self::Annotation: Borrow<Cardinality<U>>, 

Get a branch pointing to the element stored at index idx, if any

pub fn get_mut<U>(&mut self, idx: U) -> Result<Option<BranchMut<Self, H>>> where
    U: Counter,
    Self::Annotation: Borrow<Cardinality<U>>, 

Get a mutable branch pointing to the element stored at index idx, if any

Trait Implementations

impl<T: Clone, A: Clone, H: Clone> Clone for NStack<T, A, H> where
    T: Content<H>,
    Self: Compound<H>,
    H: ByteHash, 

fn clone(&self) -> NStack<T, A, H>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T, A, H> Compound<H> for NStack<T, A, H> where
    T: Content<H>,
    A: Content<H> + Annotation<T, H>,
    H: ByteHash, 

type Leaf = T

The leaf type of the compound structure

type Annotation = A

The node-annotation type

fn children(&self) -> &[Handle<Self, H>]

Returns handles to the children of the node

fn children_mut(&mut self) -> &mut [Handle<Self, H>]

Returns mutable handles to the children of the node

fn annotation(&self) -> Option<Self::Annotation>

Returns the annotation of Compound, if not empty

fn search<M>(&self, m: &mut M) -> Result<Option<Branch<Self, H>>, Error> where
    M: Method<Self, H>, 

Seach in the tree structure, with the provided method. Returns None if nothing was found, otherwise a branc pointing to the element found

fn search_mut<M>(
    &mut self,
    m: &mut M
) -> Result<Option<BranchMut<Self, H>>, Error> where
    M: Method<Self, H>, 

Seach in the tree structure, with the provided method. Returns None if nothing was found, otherwise a mutable branch pointing to the element found

fn root_hash(&mut self) -> <H as ByteHash>::Digest

Returns the hash of the Content type. This does not write anything to disk, the hashes are simply recursively computed and cached

impl<T, A, H> Content<H> for NStack<T, A, H> where
    T: Content<H>,
    A: Content<H> + Annotation<T, H>,
    H: ByteHash, 

fn persist(&mut self, sink: &mut Sink<H>) -> Result<()>

Write the type to a Sink

fn restore(source: &mut Source<H>) -> Result<Self>

Restore the type from a Source

impl<T, A, H> Default for NStack<T, A, H> where
    T: Content<H>,
    A: Content<H> + Annotation<T, H>,
    H: ByteHash, 

fn default() -> Self

Returns the "default value" for a type.