MemoryBackedTree

Struct MemoryBackedTree 

Source
pub struct MemoryBackedTree<H, T>
where H: Digest, T: HashableLeaf,
{ /* private fields */ }
Expand description

An in-memory append-only Merkle tree implementation, supporting inclusion and consistency proofs. This stores leaf values, not just leaf hashes.

Implementations§

Source§

impl<H, T> MemoryBackedTree<H, T>
where H: Digest, T: HashableLeaf,

Source

pub fn prove_consistency(&self, num_additions: usize) -> ConsistencyProof<H>

Produces a proof that this MemoryBackedTree is the result of appending num_additions items to a prefix of this tree.

§Panics

Panics if num_additions >= self.len().

Source§

impl<H, T> MemoryBackedTree<H, T>
where H: Digest, T: HashableLeaf,

Source

pub fn prove_inclusion(&self, idx: usize) -> InclusionProof<H>

Returns a proof of inclusion of the item at the given index.

§Panics

Panics if idx >= self.len().

Source§

impl<H, T> MemoryBackedTree<H, T>
where H: Digest, T: HashableLeaf,

Source

pub fn new() -> Self

Source

pub fn push(&mut self, new_val: T)

Appends the given item to the end of the list.

§Panics

Panics if self.len() > ⌊usize::MAX / 2⌋ - 1. Also panics if this tree is malformed, e.g., deserialized from disk without passing a MemoryBackedTree::self_check.

Source

pub fn self_check(&self) -> Result<(), SelfCheckError>

Checks that this tree is well-formed. This can take a while if the tree is large. Run this if you’ve deserialized this tree and don’t trust the source. If a tree is malformed, other methods will panic or behave oddly.

Source

pub fn root(&self) -> RootHash<H>

Returns the root hash of this tree. The value and type uniquely describe this tree.

§Panics

Panics if this tree is malformed, e.g., deserialized from disk without passing a MemoryBackedTree::self_check.

Source

pub fn get(&self, idx: usize) -> Option<&T>

Tries to get the item at the given index

Source

pub fn items(&self) -> &[T]

Returns all the items

Source

pub fn len(&self) -> u64

Returns the number of items

Source

pub fn is_empty(&self) -> bool

Returns true if this tree has no items

Trait Implementations§

Source§

impl<H, T> Clone for MemoryBackedTree<H, T>
where H: Digest + Clone, T: HashableLeaf + Clone,

Source§

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

Returns a duplicate 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<H, T> Debug for MemoryBackedTree<H, T>
where H: Digest + Debug, T: HashableLeaf + Debug,

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<H, T> Default for MemoryBackedTree<H, T>
where H: Digest, T: HashableLeaf,

Source§

fn default() -> Self

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

Auto Trait Implementations§

§

impl<H, T> Freeze for MemoryBackedTree<H, T>

§

impl<H, T> RefUnwindSafe for MemoryBackedTree<H, T>

§

impl<H, T> Send for MemoryBackedTree<H, T>
where T: Send,

§

impl<H, T> Sync for MemoryBackedTree<H, T>
where T: Sync,

§

impl<H, T> Unpin for MemoryBackedTree<H, T>

§

impl<H, T> UnwindSafe for MemoryBackedTree<H, T>

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,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

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> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

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)

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

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.