Struct InMemory

pub struct InMemory { /* private fields */ }

An in-memory storage backend, useful for testing.

Implementations

impl InMemory

pub fn new() -> Self

Create a new in-memory storage backend.

pub fn new_sparse() -> Self

Create a new in-memory storage backend that only stores essential hashes.

pub fn position(&self) -> StoredPosition

Get the position of the stored tree.

pub fn forgotten(&self) -> Forgotten

Get the forgotten version of the stored tree.

pub fn hashes(&self) -> impl Iterator<Item = (Position, u8, Hash)> + '_

Get an iterator of all the hashes stored.

pub fn commitments( &self, ) -> impl Iterator<Item = (Position, StateCommitment)> + '_

Get an iterator of all the commitments stored.

Trait Implementations

impl Clone for InMemory

fn clone(&self) -> InMemory

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InMemory

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

Formats the value using the given formatter.

impl Default for InMemory

fn default() -> InMemory

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for InMemory

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for InMemory

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for InMemory

fn eq(&self, other: &InMemory) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Read for InMemory

type Error = Error

The error returned when something goes wrong in a request.

type HashesIter<'a> = Box<dyn Iterator<Item = Result<(Position, u8, Hash), <InMemory as Read>::Error>> + Send + 'a>

The type of iterator returned when reading hashes from the database.

type CommitmentsIter<'a> = Box<dyn Iterator<Item = Result<(Position, StateCommitment), <InMemory as Read>::Error>> + Send + 'a>

The type of iterator returned when reading commitments from the database.

fn position(&mut self) -> Result<StoredPosition, Self::Error>

Fetch the current position stored.

fn forgotten(&mut self) -> Result<Forgotten, Self::Error>

Fetch the current forgotten version.

fn hash( &mut self, position: Position, height: u8, ) -> Result<Option<Hash>, Self::Error>

Fetch a specific hash at the given position and height, if it exists.

fn hashes(&mut self) -> Self::HashesIter<'_>

Get the full list of all internal hashes stored, indexed by position and height.

fn commitment( &mut self, position: Position, ) -> Result<Option<StateCommitment>, Self::Error>

Fetch a specific commitment at the given position, if it exists.

fn commitments(&mut self) -> Self::CommitmentsIter<'_>

Get the full list of all commitments stored, indexed by position.

impl Serialize for InMemory

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Write for InMemory

fn add_hash( &mut self, position: Position, height: u8, hash: Hash, essential: bool, ) -> Result<(), Self::Error>

Write a single hash into storage.

fn add_commitment( &mut self, position: Position, commitment: StateCommitment, ) -> Result<(), Self::Error>

Write a single commitment into storage.

fn delete_range( &mut self, below_height: u8, range: Range<Position>, ) -> Result<(), Self::Error>

Delete every stored Hash whose height is less than below_height and whose position is within the half-open Range of positions, as well as every [Commitment] whose position is within the range.

fn set_position(&mut self, position: StoredPosition) -> Result<(), Self::Error>

Set the stored position of the tree.

fn set_forgotten(&mut self, forgotten: Forgotten) -> Result<(), Self::Error>

Set the forgotten version of the tree.

impl Eq for InMemory

impl StructuralPartialEq for InMemory