Struct Field 

pub struct Field<Name>(/* private fields */);

Field of a desc file.

Implementations

impl<Name> Field<Name>

pub const fn name(&self) -> &Name

Get an immutable reference to the name of the field.

pub fn into_name(self) -> Name

Convert into the name of the field.

impl<'a> Field<&'a str>

pub const fn name_str(&self) -> &'a str

Get the name of the field as a string slice.

impl Field<FieldName>

pub const fn new(name: FieldName) -> Field<FieldName>

Create a new ParsedField.

pub fn name_str(&self) -> &'static str

Get the name of the field as a string slice.

impl<Name> Field<Name>

pub fn parse<'a>( value: &'a str, ) -> Result<Field<Name>, <Field<Name> as TryFrom<&'a str>>::Error>

where &'a str: TryInto<Name>,

Parse a Field from str.

let parsed_field = ParsedField::parse("%NAME%").unwrap();
assert_eq!(parsed_field.name(), &FieldName::Name);

impl<'a> Field<&'a str>

pub fn parse_raw(input: &'a str) -> Result<Field<&'a str>, ParseRawFieldError>

Parse a RawField from a str.

let raw_field = RawField::parse_raw("%NAME%").unwrap();
assert_eq!(raw_field.name_str(), "NAME");

pub fn to_parsed<Name>( &self, ) -> Result<Field<Name>, <&'a str as TryInto<Name>>::Error>

where &'a str: TryInto<Name>,

Try converting a RawField into a Field<Name>.

let raw_field = RawField::parse_raw("%NAME%").unwrap();
let parsed_field: ParsedField = raw_field.to_parsed().unwrap();
assert_eq!(parsed_field.name(), &FieldName::Name);

Trait Implementations

impl<Name> AsRef<Name> for Field<Name>

fn as_ref(&self) -> &Name

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

impl<Name> Clone for Field<Name>

where Name: Clone,

fn clone(&self) -> Field<Name>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Name> Debug for Field<Name>

where Name: Debug,

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

Formats the value using the given formatter.

impl<Name> Deref for Field<Name>

type Target = Name

The resulting type after dereferencing.

fn deref(&self) -> &<Field<Name> as Deref>::Target

Dereferences the value.

impl<Name> Display for Field<Name>

where Name: Display,

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

Formats the value using the given formatter.

impl From<FieldName> for Field<FieldName>

fn from(value: FieldName) -> Field<FieldName>

Converts to this type from the input type.

impl<Name> PartialEq for Field<Name>

where Name: PartialEq,

fn eq(&self, other: &Field<Name>) -> 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, Name> TryFrom<&'a str> for Field<Name>

where &'a str: TryInto<Name>,

Parse a Field from str.

type Error = ParseFieldError<<&'a str as TryInto<Name>>::Error>

The type returned in the event of a conversion error.

fn try_from( value: &'a str, ) -> Result<Field<Name>, <Field<Name> as TryFrom<&'a str>>::Error>

Performs the conversion.

impl<Name> Copy for Field<Name>

where Name: Copy,

impl<Name> Eq for Field<Name>

where Name: Eq,

impl<Name> StructuralPartialEq for Field<Name>