Struct gigtag::DecodedTags

pub struct DecodedTags<F, L, N, V> {
    pub tags: Vec<Tag<F, L, N, V>>,
    pub undecoded_prefix: String,
}

Tags decoded from a text field

Fields

tags: Vec<Tag<F, L, N, V>>

Valid, decoded tags

undecoded_prefix: String

The remaining, undecoded prefix.

Implementations

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

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

pub fn decode_str(encoded: &str) -> Self

Decode from a string slice.

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

Encode the contents into a separate buffer.

Errors

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

pub fn reencode(self) -> Result<String, Error>

Re-encode the contents.

Errors

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

pub fn reorder_and_dedup(&mut self)

Reorder and deduplicate tags.

Canonical ordering:

1. Tags without a facet
2. Tags with a non-date-like facet
3. Tags with a date-like facet (by descending suffix)

Within each group tags are sorted by facet, then by label. For tags with equal facets those with a label are sorted before those without a label.

Tags with a date-like facet are sorted in descending order by their date-like suffix, i.e. newer dates are sorted before older dates.

Trait Implementations

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

fn clone(&self) -> DecodedTags<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 DecodedTags<F, L, N, V>

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

Formats the value using the given formatter.

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

fn eq(&self, other: &DecodedTags<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 DecodedTags<F, L, N, V>

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