Struct Tag

pub struct Tag { /* private fields */ }

A representation of YAML’s !Tag syntax, used for enums.

Refer to the example code on TaggedValue for an example of deserializing tagged values.

Implementations

impl Tag

pub fn new(string: impl Into<String>) -> Self

Create tag.

The leading ‘!’ is not significant. It may be provided, but does not have to be. The following are equivalent:

use serde_yaml::value::Tag;

assert_eq!(Tag::new("!Thing"), Tag::new("Thing"));

let tag = Tag::new("Thing");
assert!(tag == "Thing");
assert!(tag == "!Thing");
assert!(tag.to_string() == "!Thing");

let tag = Tag::new("!Thing");
assert!(tag == "Thing");
assert!(tag == "!Thing");
assert!(tag.to_string() == "!Thing");

Such a tag would serialize to !Thing in YAML regardless of whether a ‘!’ was included in the call to Tag::new.

Panics

Panics if string.is_empty(). There is no syntax in YAML for an empty tag.

Trait Implementations

impl Clone for Tag

fn clone(&self) -> Tag

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Tag

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

Formats the value using the given formatter.

impl Display for Tag

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

Formats the value using the given formatter.

impl Hash for Tag

fn hash<H: Hasher>(&self, hasher: &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 Ord for Tag

fn cmp(&self, other: &Self) -> 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<T> PartialEq<T> for Tag

where T: ?Sized + AsRef<str>,

fn eq(&self, other: &T) -> 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 PartialEq for Tag

fn eq(&self, other: &Tag) -> 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 PartialOrd for Tag

fn partial_cmp(&self, other: &Self) -> 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 Eq for Tag