Struct bao_tree::BaoTree

pub struct BaoTree { /* private fields */ }

Defines a Bao tree.

This is just the specification of the tree, it does not contain any actual data.

Implementations

impl BaoTree

pub fn empty(block_size: BlockSize) -> Self

Create a new empty BaoTree with the given block size

pub fn new(size: ByteNum, block_size: BlockSize) -> Self

Create a new BaoTree

pub fn size(&self) -> ByteNum

The size of the blob from which this tree was constructed, in bytes

pub fn post_order_chunks_iter(&self) -> PostOrderChunkIter

Traverse the entire tree in post order as BaoChunks

This iterator is used by both the sync and async io code for computing an outboard from existing data

pub fn ranges_pre_order_chunks_iter_ref<'a>( &self, ranges: &'a RangeSetRef<ChunkNum>, min_level: u8 ) -> PreOrderChunkIterRef<'a>

Traverse the part of the tree that is relevant for a ranges querys in pre order as BaoChunks

This iterator is used by both the sync and async io code for encoding from an outboard and ranges as well as decoding an encoded stream.

pub fn post_order_nodes_iter(&self) -> PostOrderNodeIter

Traverse the entire tree in post order as TreeNodes

This is mostly used internally by the PostOrderChunkIter

pub fn pre_order_nodes_iter(&self) -> PreOrderNodeIter

Traverse the entire tree in pre order as TreeNodes

pub fn ranges_pre_order_nodes_iter<'a>( &self, ranges: &'a RangeSetRef<ChunkNum>, min_level: u8 ) -> PreOrderPartialIterRef<'a>

Traverse the part of the tree that is relevant for a ranges querys in pre order as NodeInfos

This is mostly used internally by the PreOrderChunkIterRef

pub fn new_with_start_chunk( size: ByteNum, block_size: BlockSize, start_chunk: ChunkNum ) -> Self

Create a new BaoTree with a start chunk

This is used for trees that are part of a larger file. The start chunk is the chunk number of the first chunk in the tree.

This is mostly used internally.

pub fn root(&self) -> TreeNode

Root of the tree

pub fn blocks(&self) -> BlockNum

Number of blocks in the tree

At chunk group size 1, this is the same as the number of chunks Even a tree with 0 bytes size has a single block

pub fn chunks(&self) -> ChunkNum

Number of chunks in the tree

pub const fn chunk_num(&self, node: LeafNode) -> ChunkNum

Given a leaf node of this tree, return its start chunk number

pub fn pre_order_offset(&self, node: TreeNode) -> Option<u64>

The offset of the given node in the pre order traversal

pub fn post_order_offset(&self, node: TreeNode) -> Option<PostOrderOffset>

The offset of the given node in the post order traversal

Trait Implementations

impl Clone for BaoTree

fn clone(&self) -> BaoTree

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BaoTree

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

Formats the value using the given formatter.

impl PartialEq<BaoTree> for BaoTree

fn eq(&self, other: &BaoTree) -> 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 Copy for BaoTree

impl Eq for BaoTree

impl StructuralEq for BaoTree

impl StructuralPartialEq for BaoTree