Struct PostOrderMemOutboard

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

A post order outboard that is optimized for memory storage.

The PostOrderOutboard will work just fine using e.g. a Vec<u8> as storage. However, it will not work for types such as bytes::Bytes or bytes::BytesMut that do not implement the io traits.

The traits are implemented for fixed size slices or mutable slices, so unlike the PostOrderOutboard, 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 without length suffix

Implementations

impl PostOrderMemOutboard

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.

It is just a shortcut that calls crate::io::sync::outboard_post_order.

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

returns the outboard data, with the length suffix.

impl<T> PostOrderMemOutboard<T>

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

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

Map the outboard data to a new type.

pub fn flip(&self) -> PreOrderMemOutboard

where T: AsRef<[u8]>,

Flip the outboard to pre order.

Trait Implementations

impl<T: Clone> Clone for PostOrderMemOutboard<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for PostOrderMemOutboard<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for PostOrderMemOutboard<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: AsRef<[u8]>> Outboard for PostOrderMemOutboard<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 PostOrderMemOutboard<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 PostOrderMemOutboard<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 PostOrderMemOutboard<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 PostOrderMemOutboard<T>

fn eq(&self, other: &PostOrderMemOutboard<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 PostOrderMemOutboard<T>

impl<T> StructuralPartialEq for PostOrderMemOutboard<T>