Struct miniconf::Metadata

#[non_exhaustive]
pub struct Metadata {
    pub max_length: usize,
    pub max_depth: usize,
    pub count: usize,
}

Metadata about a TreeKey namespace.

Metadata includes paths that may be 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 all field names/indices in a path. By default, it does not include 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. It may be smaller than the TreeKey<Y> recursion depth.

count: usize

The exact total number of keys.

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 Default for Metadata

fn default() -> Metadata

Returns the “default value” for a type.

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

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 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 Copy for Metadata

impl Eq for Metadata

impl StructuralPartialEq for Metadata