Struct bao_tree::io::outboard::PreOrderOutboard

pub struct PreOrderOutboard<R> {
    pub root: Hash,
    pub tree: BaoTree,
    pub data: R,
}

A generic outboard in pre order

Fields

root: Hash

root hash

tree: BaoTree

tree defining the data

data: R

hashes with length prefix

Implementations

impl<R> PreOrderOutboard<R>

pub fn into_inner(self) -> R

Return the inner reader

impl<R: ReadAt + Size> PreOrderOutboard<R>

pub fn new(root: Hash, block_size: BlockSize, data: R) -> Result<Self>

Create a new outboard from a reader, root hash, and block size.

Trait Implementations

impl<R: Clone> Clone for PreOrderOutboard<R>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<R: Debug> Debug for PreOrderOutboard<R>

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

Formats the value using the given formatter.

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

type LoadFuture<'a> = Pin<Box<dyn Future<Output = Result<Option<(Hash, Hash)>, Error>> + 'a>> where R: 'a

Future returned by load

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(&mut self, node: TreeNode) -> Self::LoadFuture<'_>

load the hash pair for a node

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

type SaveFuture<'a> = Pin<Box<dyn Future<Output = Result<(), Error>> + 'a>> where W: 'a

Future returned by save

fn save<'a>( &'a mut self, node: TreeNode, hash_pair: &'a (Hash, Hash) ) -> Self::SaveFuture<'_>

Save a hash pair for a node

type SyncFuture<'a> = <W as AsyncSliceWriter>::SyncFuture<'a> where W: 'a

Future returned by sync

fn sync(&mut self) -> Self::SyncFuture<'_>

sync to disk

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

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

Save a hash pair for a node