Struct toml_edit::Key

pub struct Key { /* fields omitted */ }

Key as part of a Key/Value Pair or a table header.

Examples

[dependencies."nom"]
version = "5.0"
'literal key' = "nonsense"
"basic string key" = 42

There are 3 types of keys:

1. Bare keys (version and dependencies)

2. Basic quoted keys ("basic string key" and "nom")

3. Literal quoted keys ('literal key')

For details see toml spec.

To parse a key use FromStr trait implementation: "string".parse::<Key>().

Implementations

impl Key

pub fn new(key: impl Into<InternalString>) -> Self

Create a new table key

pub fn with_decor(self, decor: Decor) -> Self

While creating the Key, add Decor to it

pub fn get(&self) -> &str

Returns the parsed key value.

pub fn to_repr(&self) -> Cow<'_, Repr>

Returns the key raw representation.

pub fn decor_mut(&mut self) -> &mut Decor

Returns the surrounding whitespace

pub fn decor(&self) -> &Decor

Returns the surrounding whitespace

pub fn fmt(&mut self)

Auto formats the key.

Trait Implementations

impl Clone for Key

fn clone(&self) -> Key

Returns a copy of the value.

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

Performs copy-assignment from source.

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<'b> From<&'b String> for Key

fn from(s: &'b String) -> Self

Performs the conversion.

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

fn from(s: &'b str) -> Self

Performs the conversion.

impl From<InternalString> for Key

fn from(s: InternalString) -> Self

Performs the conversion.

impl From<String> for Key

fn from(s: String) -> Self

Performs the conversion.

impl FromStr for Key

fn from_str(s: &str) -> Result<Self, Self::Err>

Tries to parse a key from a &str, if fails, tries as basic quoted key (surrounds with “”) and then literal quoted key (surrounds with ‘’)

type Err = TomlError

The associated error which can be returned from parsing.

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, 

Feeds a slice of this type into the given Hasher.

impl Ord for Key

fn cmp(&self, other: &Key) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Key> for Key

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<Key> for Key

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Eq for Key

impl StructuralEq for Key

impl StructuralPartialEq for Key