Struct Metadata

#[non_exhaustive]
pub struct Metadata {
    pub max_length: usize,
    pub max_depth: usize,
    pub count: NonZero<usize>,
    pub max_bits: u32,
}

Metadata about a TreeKey namespace.

Metadata includes paths that may be crate::Traversal::Absent at runtime.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

max_length: usize

The maximum length of a path in bytes.

This is the exact maximum of the length of the concatenation of the node names in a crate::Path excluding the separators. See Self::max_length() for the maximum length including separators.

max_depth: usize

The maximum key depth.

This is equal to the exact maximum number of path hierarchy separators. It’s the exact maximum number of key indices.

count: NonZero<usize>

The exact total number of keys.

max_bits: u32

The maximum number of bits (see crate::Packed)

Implementations

impl Metadata

pub fn max_length(&self, separator: &str) -> usize

Add separator length to the maximum path length.

To obtain an upper bound on the maximum length of all paths including separators, this adds max_depth*separator_length.

Trait Implementations

impl Clone for Metadata

fn clone(&self) -> Metadata

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Metadata

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Metadata

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Metadata

fn eq(&self, other: &Metadata) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Metadata

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Walk for Metadata

type Error = Infallible

Error type for merge()

fn leaf() -> Self

Return the walk starting point for a single leaf node

fn internal(children: &[&Self], lookup: &KeyLookup) -> Result<Self, Self::Error>

Merge node metadata into self.

impl Copy for Metadata

impl Eq for Metadata

impl StructuralPartialEq for Metadata