Struct PreOrderOutboard

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

A generic outboard in pre order

All fields are public, so an outboard does not enforce any invariants. This is necessary since we want outboards to exist in an incomplete state where data does not match the root hash.

Caution: unlike the outboard implementation in the bao crate, this implementation does not assume an 8 byte size prefix.

Fields

root: Hash

root hash

tree: BaoTree

tree defining the data

data: D

hashes with length prefix

Trait Implementations

impl<D: Clone> Clone for PreOrderOutboard<D>

fn clone(&self) -> PreOrderOutboard<D>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<W: AsyncSliceWriter> CreateOutboard for PreOrderOutboard<W>

async fn create_sized( data: impl AsyncStreamReader, size: u64, block_size: BlockSize, ) -> Result<Self>

where Self: Default + Sized,

create an outboard from a data source. This requires the outboard to have a default implementation, which is the case for the memory implementations.

async fn init_from(&mut self, data: impl AsyncStreamReader) -> Result<()>

Init the outboard from a data source. This will use the existing tree and only init the data and set the root hash.

async fn create( data: impl AsyncSliceReader, block_size: BlockSize, ) -> Result<Self>

where Self: Default + Sized,

Create an outboard from a seekable data source, measuring the size first.

impl<W: WriteAt> CreateOutboard for PreOrderOutboard<W>

fn create_sized( data: impl Read, size: u64, block_size: BlockSize, ) -> Result<Self>

where Self: Default + Sized,

create an outboard from a data source. This requires the outboard to have a default implementation, which is the case for the memory implementations.

fn init_from(&mut self, data: impl Read) -> Result<()>

Init the outboard from a data source. This will use the existing tree and only init the data and set the root hash.

fn create(data: impl Read + Seek, block_size: BlockSize) -> Result<Self>

where Self: Default + Sized,

Create an outboard from a data source.

impl<D: Debug> Debug for PreOrderOutboard<D>

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

Formats the value using the given formatter.

impl<R: Default> Default for PreOrderOutboard<R>

fn default() -> Self

Returns the “default value” for a type.

impl<R: AsyncSliceReader> Outboard for PreOrderOutboard<R>

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<R: ReadAt> Outboard for PreOrderOutboard<R>

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<W: AsyncSliceWriter> OutboardMut for PreOrderOutboard<W>

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

Save a hash pair for a node

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

sync to disk

impl<W: WriteAt> OutboardMut for PreOrderOutboard<W>

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

Save a hash pair for a node

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

Sync the outboard.