Struct bao_tree::TreeNode

pub struct TreeNode(/* private fields */);

An u64 that defines a node in a bao tree.

You typically don’t have to use this, but it can be useful for debugging and error handling. Hash validation errors contain a TreeNode that allows you to find the position where validation failed.

Implementations

impl TreeNode

pub const fn mid(&self) -> ChunkNum

the middle of the tree node, in blocks

pub const fn level(&self) -> u32

The level of the node in the tree, 0 for leafs.

pub const fn is_leaf(&self) -> bool

True if this is a leaf node.

pub const fn subtract_block_size(&self, n: u8) -> Self

Convert a node to a node in a tree with a smaller block size

E.g. a leaf node in a tree with block size 4 will become a node with level 4 in a tree with block size 0.

This works by just adding n trailing 1 bits to the node by shifting to the left.

pub const fn add_block_size(&self, n: u8) -> Option<Self>

Convert a node to a node in a tree with a larger block size

If the nodes has n trailing 1 bits, they are removed by shifting the node to the right by n bits.

If the node has less than n trailing 1 bits, the node is too small to be represented in the target tree.

pub const fn count_below(&self) -> u64

Number of nodes below this node, excluding this node.

pub fn next_left_ancestor(&self) -> Option<Self>

Get the next left ancestor of this node, or None if there is none.

pub fn left_child(&self) -> Option<Self>

Get the left child of this node, or None if it is a child node.

pub fn right_child(&self) -> Option<Self>

Get the right child of this node, or None if it is a child node.

pub fn parent(&self) -> Option<Self>

Unrestricted parent, can only be None if we are at the top

pub fn restricted_parent(&self, len: Self) -> Option<Self>

Restricted parent, will be None if we call parent on the root

pub const fn node_range(&self) -> Range<Self>

Get the range of nodes this node covers

pub fn chunk_range(&self) -> Range<ChunkNum>

Get the range of blocks this node covers

pub fn right_count(&self) -> u32

the number of times you have to go right from the root to get to this node

0 for a root node

pub const fn post_order_offset(&self) -> u64

Get the post order offset of this node

pub const fn post_order_range(&self) -> Range<u64>

Get the range of post order offsets this node covers

Trait Implementations

impl Clone for TreeNode

fn clone(&self) -> TreeNode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TreeNode

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

Formats the value using the given formatter.

impl Display for TreeNode

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

Formats the value using the given formatter.

impl Ord for TreeNode

fn cmp(&self, other: &TreeNode) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for TreeNode

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

fn partial_cmp(&self, other: &TreeNode) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for TreeNode

impl Eq for TreeNode

impl StructuralPartialEq for TreeNode