Struct Key 

pub struct Key<'de> {
    pub name: &'de str,
    pub span: Span,
}

A TOML table key with its source span.

Keys appear as the first element in (Key, Item) entry pairs when iterating over a Table.

Fields

name: &'de str

The key name.

span: Span

The byte-offset span of the key in the source document.

Implementations

impl<'de> Key<'de>

pub fn new(value: &'de str) -> Self

Creates a key with no source span.

Use this when constructing tables programmatically via Table::insert.

pub fn as_str(&self) -> &'de str

Returns the key name as a string slice.

Trait Implementations

impl Borrow<str> for Key<'_>

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl<'de> Clone for Key<'de>

fn clone(&self) -> Key<'de>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'de> Copy for Key<'de>

impl Debug for Key<'_>

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

Formats the value using the given formatter.

impl Display for Key<'_>

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

Formats the value using the given formatter.

impl Eq for Key<'_>

impl<'de> From<&'de str> for Key<'de>

fn from(value: &'de str) -> Self

Converts to this type from the input type.

impl Hash for Key<'_>

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 Key<'_>

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.

impl PartialEq for Key<'_>

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

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.