Struct dusk_poseidon::tree::PoseidonTree

source · [−]

pub struct PoseidonTree<L, A, const DEPTH: usize> where
    L: PoseidonLeaf,
    A: PoseidonTreeAnnotation<L>,  { /* private fields */ }

Expand description

Represents a Merkle Tree with a given depth that will be calculated using the Poseidon Hash technique.

Implementations

source

impl<L, A, const DEPTH: usize> PoseidonTree<L, A, DEPTH> where
L: PoseidonLeaf,
A: PoseidonTreeAnnotation<L>,

source

pub fn new() -> Self

Creates a new poseidon tree

source

pub fn push(&mut self, leaf: L) -> Result<u64, Error>

Append a leaf to the tree. Return the index of the appended leaf.

source

pub fn pop(&mut self) -> Result<Option<L>, Error>

Fetch, remove and return the last inserted leaf, if present.

source

pub fn get(&self, n: u64) -> Result<Option<L>, Error>

Fetch a leaf on a provided index.

source

pub fn branch(&self, n: u64) -> Result<Option<PoseidonBranch<DEPTH>>, Error>

Return a full merkle opening for this poseidon tree for a given index.

source

pub fn root(&self) -> Result<BlsScalar, Error>

Return the current root/state of the tree.

source

pub fn iter_walk(
&self,
start: u64
) -> Result<impl IntoIterator<Item = Result<&L, CanonError>>, Error>

Provides an iterator over the leaves of the tree from a provided starting point. To iterate the entire tree, simply provide 0 as start.

source

pub fn annotated_iter_walk<W>(
 &self,
 walker: W
) -> Result<impl IntoIterator<Item = Result<&L, CanonError>>, Error> where
 W: Walker<NStack<L, A>, A>,

Provides an iterator over the leaves of the tree which have been previously annotated via a custom Walker passed as argument.

Note

This is only useful if annotate the tree is going to make the iteration perform sub-linearly.

Trait Implementations

source

impl<L, A, const DEPTH: usize> AsMut<NStack<L, A>> for PoseidonTree<L, A, DEPTH> where
L: PoseidonLeaf,
A: PoseidonTreeAnnotation<L>,

source

fn as_mut(&mut self) -> &mut NStack<L, A>

Performs the conversion.

source

impl<L, A, const DEPTH: usize> AsRef<NStack<L, A>> for PoseidonTree<L, A, DEPTH> where
L: PoseidonLeaf,
A: PoseidonTreeAnnotation<L>,

source

fn as_ref(&self) -> &NStack<L, A>

Performs the conversion.

source

impl<L: Canon, A: Canon, const DEPTH: usize> Canon for PoseidonTree<L, A, DEPTH> where
L: PoseidonLeaf,
A: PoseidonTreeAnnotation<L>,

source

fn encode(&self, sink: &mut Sink<'_>)

Write the encoded value as bytes to a Sink

source

fn decode(source: &mut Source<'_>) -> Result<Self, CanonError>

Return the decoded value from bytes in a Source

source

fn encoded_len(&self) -> usize

Returns the number of bytes needed to encode this value

source

impl<L: Clone, A: Clone, const DEPTH: usize> Clone for PoseidonTree<L, A, DEPTH> where
L: PoseidonLeaf,
A: PoseidonTreeAnnotation<L>,

source

fn clone(&self) -> PoseidonTree<L, A, DEPTH>

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl<L: Debug, A: Debug, const DEPTH: usize> Debug for PoseidonTree<L, A, DEPTH> where
L: PoseidonLeaf,
A: PoseidonTreeAnnotation<L>,

source

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

Formats the value using the given formatter. Read more

source

impl<L, A, const DEPTH: usize> Default for PoseidonTree<L, A, DEPTH> where
L: PoseidonLeaf,
A: PoseidonTreeAnnotation<L>,

source

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations

impl<L, A, const DEPTH: usize> !RefUnwindSafe for PoseidonTree<L, A, DEPTH>

impl<L, A, const DEPTH: usize> Send for PoseidonTree<L, A, DEPTH> where
A: Send + Sync,
L: Send + Sync,

impl<L, A, const DEPTH: usize> Sync for PoseidonTree<L, A, DEPTH> where
A: Send + Sync,
L: Send + Sync,

impl<L, A, const DEPTH: usize> Unpin for PoseidonTree<L, A, DEPTH> where
A: Unpin,
L: Unpin,

impl<L, A, const DEPTH: usize> !UnwindSafe for PoseidonTree<L, A, DEPTH>

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> EncodeToVec for T where
T: Canon,

source

fn encode_to_vec(&self) -> Vec<u8, Global>

Encode Self into a buffer

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> Keyed<T> for T

source

fn key(&self) -> &T

Return a reference to the key of the leaf type

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

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

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct dusk_poseidon::tree::PoseidonTree

Implementations

impl<L, A, const DEPTH: usize> PoseidonTree<L, A, DEPTH> where L: PoseidonLeaf, A: PoseidonTreeAnnotation<L>,

pub fn new() -> Self

pub fn push(&mut self, leaf: L) -> Result<u64, Error>

pub fn pop(&mut self) -> Result<Option<L>, Error>

pub fn get(&self, n: u64) -> Result<Option<L>, Error>

pub fn branch(&self, n: u64) -> Result<Option<PoseidonBranch<DEPTH>>, Error>

pub fn root(&self) -> Result<BlsScalar, Error>

pub fn iter_walk( &self, start: u64) -> Result<impl IntoIterator<Item = Result<&L, CanonError>>, Error>

pub fn annotated_iter_walk<W>( &self, walker: W) -> Result<impl IntoIterator<Item = Result<&L, CanonError>>, Error> where W: Walker<NStack<L, A>, A>,

Trait Implementations

impl<L, A, const DEPTH: usize> AsMut<NStack<L, A>> for PoseidonTree<L, A, DEPTH> where L: PoseidonLeaf, A: PoseidonTreeAnnotation<L>,

fn as_mut(&mut self) -> &mut NStack<L, A>

impl<L, A, const DEPTH: usize> AsRef<NStack<L, A>> for PoseidonTree<L, A, DEPTH> where L: PoseidonLeaf, A: PoseidonTreeAnnotation<L>,

fn as_ref(&self) -> &NStack<L, A>

impl<L: Canon, A: Canon, const DEPTH: usize> Canon for PoseidonTree<L, A, DEPTH> where L: PoseidonLeaf, A: PoseidonTreeAnnotation<L>,

fn encode(&self, sink: &mut Sink<'_>)

fn decode(source: &mut Source<'_>) -> Result<Self, CanonError>

fn encoded_len(&self) -> usize

impl<L: Clone, A: Clone, const DEPTH: usize> Clone for PoseidonTree<L, A, DEPTH> where L: PoseidonLeaf, A: PoseidonTreeAnnotation<L>,

fn clone(&self) -> PoseidonTree<L, A, DEPTH>

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

impl<L: Debug, A: Debug, const DEPTH: usize> Debug for PoseidonTree<L, A, DEPTH> where L: PoseidonLeaf, A: PoseidonTreeAnnotation<L>,

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

impl<L, A, const DEPTH: usize> Default for PoseidonTree<L, A, DEPTH> where L: PoseidonLeaf, A: PoseidonTreeAnnotation<L>,

fn default() -> Self

Auto Trait Implementations

impl<L, A, const DEPTH: usize> !RefUnwindSafe for PoseidonTree<L, A, DEPTH>

impl<L, A, const DEPTH: usize> Send for PoseidonTree<L, A, DEPTH> where A: Send + Sync, L: Send + Sync,

impl<L, A, const DEPTH: usize> Sync for PoseidonTree<L, A, DEPTH> where A: Send + Sync, L: Send + Sync,

impl<L, A, const DEPTH: usize> Unpin for PoseidonTree<L, A, DEPTH> where A: Unpin, L: Unpin,

impl<L, A, const DEPTH: usize> !UnwindSafe for PoseidonTree<L, A, DEPTH>

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> EncodeToVec for T where T: Canon,

fn encode_to_vec(&self) -> Vec<u8, Global>

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> Keyed<T> for T

fn key(&self) -> &T

impl<T> Pointable for T

const ALIGN: usize

type Init = T

unsafe fn init(init: <T as Pointable>::Init) -> usize

unsafe fn deref<'a>(ptr: usize) -> &'a T

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

unsafe fn drop(ptr: usize)

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<L, A, const DEPTH: usize> PoseidonTree<L, A, DEPTH> where
L: PoseidonLeaf,
A: PoseidonTreeAnnotation<L>,

pub fn iter_walk(
&self,
start: u64
) -> Result<impl IntoIterator<Item = Result<&L, CanonError>>, Error>

pub fn annotated_iter_walk<W>(
&self,
walker: W
) -> Result<impl IntoIterator<Item = Result<&L, CanonError>>, Error> where
W: Walker<NStack<L, A>, A>,

impl<L, A, const DEPTH: usize> AsMut<NStack<L, A>> for PoseidonTree<L, A, DEPTH> where
L: PoseidonLeaf,
A: PoseidonTreeAnnotation<L>,

impl<L, A, const DEPTH: usize> AsRef<NStack<L, A>> for PoseidonTree<L, A, DEPTH> where
L: PoseidonLeaf,
A: PoseidonTreeAnnotation<L>,

impl<L: Canon, A: Canon, const DEPTH: usize> Canon for PoseidonTree<L, A, DEPTH> where
L: PoseidonLeaf,
A: PoseidonTreeAnnotation<L>,

impl<L: Clone, A: Clone, const DEPTH: usize> Clone for PoseidonTree<L, A, DEPTH> where
L: PoseidonLeaf,
A: PoseidonTreeAnnotation<L>,

impl<L: Debug, A: Debug, const DEPTH: usize> Debug for PoseidonTree<L, A, DEPTH> where
L: PoseidonLeaf,
A: PoseidonTreeAnnotation<L>,

impl<L, A, const DEPTH: usize> Default for PoseidonTree<L, A, DEPTH> where
L: PoseidonLeaf,
A: PoseidonTreeAnnotation<L>,

impl<L, A, const DEPTH: usize> Send for PoseidonTree<L, A, DEPTH> where
A: Send + Sync,
L: Send + Sync,

impl<L, A, const DEPTH: usize> Sync for PoseidonTree<L, A, DEPTH> where
A: Send + Sync,
L: Send + Sync,

impl<L, A, const DEPTH: usize> Unpin for PoseidonTree<L, A, DEPTH> where
A: Unpin,
L: Unpin,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T> EncodeToVec for T where
T: Canon,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,