Enum FieldKey 

pub enum FieldKey<'a> {
    Flat(Cow<'a, str>),
    Dom(FieldCategory, Cow<'a, str>),
}

A key for field lookup in schemas and solvers.

For flat formats (JSON, TOML), keys are just field names. For DOM formats (XML, HTML), keys include a category (attribute, element, text).

Variants

Flat(Cow<'a, str>)

Flat format key - just a name (for JSON, TOML, YAML, etc.)

Dom(FieldCategory, Cow<'a, str>)

DOM format key - category + name (for XML, HTML)

Implementations

impl<'a> FieldKey<'a>

pub fn flat(name: impl Into<Cow<'a, str>>) -> Self

Create a flat key from a string.

pub fn attribute(name: impl Into<Cow<'a, str>>) -> Self

Create a DOM attribute key.

pub fn element(name: impl Into<Cow<'a, str>>) -> Self

Create a DOM element key.

pub fn text() -> Self

Create a DOM text key.

pub fn tag() -> Self

Create a DOM tag key.

pub fn elements() -> Self

Create a DOM elements key (catch-all for unmatched children).

pub fn name(&self) -> &str

Get the name portion of the key.

pub fn category(&self) -> Option<FieldCategory>

Get the category if this is a DOM key.

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

Convert to an owned version with ’static lifetime.

Trait Implementations

impl<'a> Clone for FieldKey<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for FieldKey<'a>

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

Formats the value using the given formatter.

impl Display for FieldKey<'_>

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

Formats the value using the given formatter.

impl<'a> From<&'a String> for FieldKey<'a>

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

Converts to this type from the input type.

impl<'a> From<&'a str> for FieldKey<'a>

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

Converts to this type from the input type.

impl<'a> From<Cow<'a, str>> for FieldKey<'a>

fn from(s: Cow<'a, str>) -> Self

Converts to this type from the input type.

impl From<String> for FieldKey<'static>

fn from(s: String) -> Self

Converts to this type from the input type.

impl<'a> Hash for FieldKey<'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 FieldKey<'a>

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

fn eq(&self, other: &FieldKey<'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 FieldKey<'a>

fn partial_cmp(&self, other: &FieldKey<'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> Eq for FieldKey<'a>

impl<'a> StructuralPartialEq for FieldKey<'a>