Struct Level 

pub struct Level<'a>(/* private fields */);

One level of a path: a name, as the store means a name.

Not a run of a joined key. A name holding a separator is still one name - dark.mode is a level called dark.mode, not two - and the joined form spells it with the separator doubled. Which is the whole reason this is a type: the two are the same characters often enough that a &str between them says nothing, and wrong often enough that it matters.

Borrowed where the level is a run of the joined form, which is every level whose name carries nothing to escape, and held where it is not. A held name is a SmolStr, the same way the level list of a path holds one, so a name of 23 bytes or fewer costs no allocation to keep.

Implementations

impl<'a> Level<'a>

pub fn named(name: &'a str) -> Self

A name a caller wrote or a document holds, taken as the name it is.

The entry point from outside: a level read off a document’s own map, or handed in by whoever is addressing the store. Nothing is checked here beyond what the type says, because a name is any string at all - the empty one included, which every format this library writes lets a member carry.

pub fn as_str(&self) -> &str

The name as characters, for handing to a document or an engine.

pub fn into_owned(self) -> Level<'static>

The name with a life of its own.

impl Level<'static>

pub fn held(name: SmolStr) -> Self

A name already held the way a level holds one, taken without copying it again.

For a caller that has spelled the name itself - see SmolStrBuilder, which writes a short one into the inline form and never reaches the heap.

Trait Implementations

impl AsRef<str> for Level<'_>

A level is a name, and StorePath::from_segments takes names.

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<str> for Level<'_>

A level is its name, and equality, order and hashing all answer from it - which is what lets a collection keyed by a level be looked up by one.

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl<'a> Clone for Level<'a>

fn clone(&self) -> Level<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Level<'_>

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

Formats the value using the given formatter.

impl Display for Level<'_>

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

Formats the value using the given formatter.

impl Eq for Level<'_>

impl Hash for Level<'_>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Level<'_>

fn cmp(&self, other: &Self) -> 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,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Level<'_>

By the name, whichever form holds it, so a level that was assembled answers like the one that was borrowed.

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<&str> for Level<'_>

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<str> for Level<'_>

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Level<'_>

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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