Struct KeyRef

pub struct KeyRef<'a> {
    pub section_name: &'a str,
    pub subsection_name: Option<&'a BStr>,
    pub value_name: &'a str,
}

An unvalidated parse result of parsing input like remote.origin.url or core.bare.

Fields

section_name: &'a str

The name of the section, like core in core.bare.

subsection_name: Option<&'a BStr>

The name of the subsection, like origin in remote.origin.url.

value_name: &'a str

The name of the section key, like url in remote.origin.url.

Implementations

impl KeyRef<'_>

Lifecycle

pub fn parse_unvalidated(input: &BStr) -> Option<KeyRef<'_>>

Parse input like core.bare or remote.origin.url as a Key to make its fields available, or None if there were not at least 2 tokens separated by .. Note that input isn’t validated, and is str as ascii is a subset of UTF-8 which is required for any valid keys.

Trait Implementations

impl AsKey for KeyRef<'_>

fn as_key(&self) -> KeyRef<'_>

Return a parsed key reference, containing all relevant parts of a key. For instance, remote.origin.url such key would yield access to ("remote", Some("origin"), "url") while user.name would yield ("user", None, "name").

fn try_as_key(&self) -> Option<KeyRef<'_>>

Return a parsed key reference, containing all relevant parts of a key. For instance, remote.origin.url such key would yield access to ("remote", Some("origin"), "url") while user.name would yield ("user", None, "name").

impl<'a> Clone for KeyRef<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for KeyRef<'a>

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

Formats the value using the given formatter.

impl<'a> Hash for KeyRef<'a>

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<'a> Ord for KeyRef<'a>

fn cmp(&self, other: &KeyRef<'a>) -> 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.

impl<'a> PartialEq for KeyRef<'a>

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

fn partial_cmp(&self, other: &KeyRef<'a>) -> 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.

impl<'a> Copy for KeyRef<'a>

impl<'a> Eq for KeyRef<'a>

impl<'a> StructuralPartialEq for KeyRef<'a>