Struct gigtag::Tag

pub struct Tag<F, L, N, V> {
    pub label: L,
    pub facet: F,
    pub props: Vec<Property<N, V>>,
}

A tag

Fields

label: L

The label

facet: F

The facet

props: Vec<Property<N, V>>

The properties

Implementations

impl<F, L, N, V> Tag<F, L, N, V>

where F: Facet, L: Label, N: Name,

pub fn has_label(&self) -> bool

Check for a non-empty label.

pub fn label(&self) -> &L

Return the empty or valid label.

pub fn has_facet(&self) -> bool

Check for a non-empty facet.

pub fn facet(&self) -> &F

Return the empty or valid facet.

pub fn has_props(&self) -> bool

Check for non-empty properties.

pub fn props(&self) -> &[Property<N, V>]

Return the properties.

pub fn is_valid(&self) -> bool

Check if the tag is valid.

impl<F, L, N, V> Tag<F, L, N, V>

where F: Facet, L: Label, N: Name, V: AsRef<str>,

pub fn encode_into<W: Write>(&self, write: &mut W) -> Result

Encode a tag as a string.

The tag must be valid.

Errors

Returns an fmt::Error if writing into the buffer fails.

pub fn encode(&self) -> String

Encode a tag as a string.

The tag must be valid.

impl<F, L, N, V> Tag<F, L, N, V>

where F: Facet, L: Label, N: Name, V: Value,

pub fn decode_str(encoded: &str) -> Result<Self, DecodeError>

Decode a tag from an encoded token.

The encoded input must not contain any leading/trailing whitespace. The caller is responsible to ensure that no leading/trailing whitespace is present if decoding should not fail because of this. Separating whitespace between tokens should already be discarded when tokenizing the input text.

Errors

Returns a DecodeError if the encoded input cannot be decoded as a valid tag.

Trait Implementations

impl<F: Clone, L: Clone, N: Clone, V: Clone> Clone for Tag<F, L, N, V>

fn clone(&self) -> Tag<F, L, N, V>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F: Debug, L: Debug, N: Debug, V: Debug> Debug for Tag<F, L, N, V>

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

Formats the value using the given formatter.

impl<F: Default, L: Default, N: Default, V: Default> Default for Tag<F, L, N, V>

fn default() -> Tag<F, L, N, V>

Returns the “default value” for a type.

impl<F, L, N, V> Display for Tag<F, L, N, V>

where F: Facet, L: Label, N: Name, V: AsRef<str>,

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

Formats the value using the given formatter.

impl<F, L, N, V> FromStr for Tag<F, L, N, V>

where F: Facet, L: Label, N: Name, V: Value,

type Err = DecodeError

The associated error which can be returned from parsing.

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

Parses a string s to return a value of this type.

impl<F: PartialEq, L: PartialEq, N: PartialEq, V: PartialEq> PartialEq for Tag<F, L, N, V>

fn eq(&self, other: &Tag<F, L, N, V>) -> bool

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<F: Eq, L: Eq, N: Eq, V: Eq> Eq for Tag<F, L, N, V>

impl<F, L, N, V> StructuralPartialEq for Tag<F, L, N, V>