Struct blart::Header

pub struct Header {
    pub num_children: u16,
    pub prefix: TinyVec<[u8; 8]>,
}

The common header for all inner nodes

Fields

num_children: u16

Number of children of this inner node. This field has no meaning for a leaf node.

prefix: TinyVec<[u8; 8]>

The key prefix for this node.

Implementations

impl Header

pub fn empty() -> Self

Create a new Header for an empty node.

pub fn extend_prefix(&mut self, new_bytes: &[u8])

Write prefix bytes to this header, appending to existing bytes if present.

pub fn prepend_prefix(&mut self, new_bytes: &[u8])

Write bytes to the start of the key prefix.

pub fn ltrim_prefix(&mut self, num_bytes: usize)

Remove the specified number of bytes from the start of the prefix.

Panics

• Panics if the number of bytes to remove is greater than the prefix size.

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

Read the initialized portion of the prefix present in the header.

pub fn prefix_size(&self) -> usize

Return the number of bytes in the prefix.

pub fn match_prefix(&self, possible_key: &[u8]) -> usize

Compares the compressed path of a node with the key and returns the number of equal bytes.

pub fn num_children(&self) -> usize

Return the number of children of this node.

Trait Implementations

impl Clone for Header

fn clone(&self) -> Header

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Header

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

Formats the value using the given formatter.

impl Default for Header

fn default() -> Header

Returns the “default value” for a type.

impl PartialEq<Header> for Header

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

impl StructuralEq for Header

impl StructuralPartialEq for Header