Struct PreOrderMemOutboard

pub struct PreOrderMemOutboard<T = Vec<u8>> {
    pub root: Hash,
    pub tree: BaoTree,
    pub data: T,
}

A pre order outboard that is optimized for memory storage.

The traits are implemented for fixed size slices or mutable slices, so you must make sure that the data is already the right size.

Fields

root: Hash

root hash

tree: BaoTree

tree defining the data

data: T

hashes with length prefix

Implementations

impl PreOrderMemOutboard

pub fn into_inner_with_prefix(self) -> Vec<u8>

returns the outboard data, with the length prefix added.

pub fn create(data: impl AsRef<[u8]>, block_size: BlockSize) -> Self

Create a new outboard from data and a block_size.

This will hash the data and create an outboard

impl<T> PreOrderMemOutboard<T>

pub fn map_data<F, U>(self, f: F) -> PreOrderMemOutboard<U>

where F: FnOnce(T) -> U, U: AsRef<[u8]>,

Map the outboard data to a new type.

pub fn flip(&self) -> PostOrderMemOutboard

where T: AsRef<[u8]>,

Flip the outboard to a post order outboard.

Trait Implementations

impl<T: Clone> Clone for PreOrderMemOutboard<T>

fn clone(&self) -> PreOrderMemOutboard<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for PreOrderMemOutboard<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for PreOrderMemOutboard<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: AsRef<[u8]>> Outboard for PreOrderMemOutboard<T>

fn root(&self) -> Hash

The root hash

fn tree(&self) -> BaoTree

The tree. This contains the information about the size of the file and the block size.

fn load(&self, node: TreeNode) -> Result<Option<(Hash, Hash)>>

load the hash pair for a node

impl<T: AsRef<[u8]>> Outboard for PreOrderMemOutboard<T>

fn root(&self) -> Hash

The root hash

fn tree(&self) -> BaoTree

The tree. This contains the information about the size of the file and the block size.

async fn load(&mut self, node: TreeNode) -> Result<Option<(Hash, Hash)>>

load the hash pair for a node

impl<T: AsMut<[u8]>> OutboardMut for PreOrderMemOutboard<T>

fn save(&mut self, node: TreeNode, pair: &(Hash, Hash)) -> Result<()>

Save a hash pair for a node

fn sync(&mut self) -> Result<()>

Sync the outboard.

impl<T: AsMut<[u8]>> OutboardMut for PreOrderMemOutboard<T>

async fn save(&mut self, node: TreeNode, pair: &(Hash, Hash)) -> Result<()>

Save a hash pair for a node

async fn sync(&mut self) -> Result<()>

sync to disk

impl<T: PartialEq> PartialEq for PreOrderMemOutboard<T>

fn eq(&self, other: &PreOrderMemOutboard<T>) -> 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<T: Eq> Eq for PreOrderMemOutboard<T>

impl<T> StructuralPartialEq for PreOrderMemOutboard<T>