Struct bao_tree::io::outboard::PreOrderMemOutboard

pub struct PreOrderMemOutboard<T = Vec<u8>> {
    pub data: T,
    /* private fields */
}

A pre order outboard that is optimized for memory storage.

Fields

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: AsRef<[u8]>> PreOrderMemOutboard<T>

pub fn new( root: Hash, tree: BaoTree, outboard_data: T ) -> Result<Self, &'static str>

Create a new outboard from a root hash, tree, and existing outboard data.

This will just do a check that the data is the right size, but not check the actual hashes.

Note that if you have data with a length prefix, you have to remove the prefix first.

pub fn map_data<F, U>( self, f: F ) -> Result<PreOrderMemOutboard<U>, &'static str>

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

Map the outboard data to a new type.

pub fn outboard(&self) -> &[u8]

The outboard data, including the length prefix.

pub fn hash(&self) -> &Hash

The root hash.

pub fn into_inner(self) -> T

Get the inner data.

pub fn flip(&self) -> PostOrderMemOutboard

Flip the outboard to a post order outboard.

impl PreOrderMemOutboard

pub fn load( root: Hash, outboard_reader: impl ReadAt + Size, block_size: BlockSize ) -> Result<Self>

Load a pre-order outboard from a reader, root hash, and block size.

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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]> + 'static> 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>

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: AsMut<[u8]>> OutboardMut for PreOrderMemOutboard<T>

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

Save a hash pair for a node

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

fn eq(&self, other: &PreOrderMemOutboard<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method 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>