Struct Tag 

pub struct Tag(/* private fields */);

A YAML tag.

Tags are used in YAML to denote the type of a value. For example, !custom_type value has the tag !custom_type.

Tag comparison ignores a leading ! prefix, so Tag::new("!foo") == Tag::new("foo").

Examples

use noyalib::Tag;

let tag = Tag::new("!custom");
assert_eq!(tag.as_str(), "!custom");
assert_eq!(Tag::new("!foo"), Tag::new("foo"));

Implementations

impl Tag

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

Creates a new tag from a string.

Examples

use noyalib::Tag;
let t = Tag::new("!Custom");
assert_eq!(t.as_str(), "!Custom");

pub fn as_str(&self) -> &str

Returns the tag as a string slice.

The leading ! (or !!) is included; use Tag::nobang for the unprefixed form.

Examples

use noyalib::Tag;
assert_eq!(Tag::new("!Custom").as_str(), "!Custom");
assert_eq!(Tag::new("!!str").as_str(), "!!str");

pub fn into_string(self) -> String

Consumes the tag and returns the inner string.

Examples

use noyalib::Tag;
let s: String = Tag::new("!Custom").into_string();
assert_eq!(s, "!Custom");

pub fn nobang(&self) -> &str

Returns the tag string with a single leading ! stripped.

Strips at most one ! — the YAML 1.2 primary tag handle. The secondary !! handle keeps one ! after the strip (!!str → !str); use Tag::as_str().trim_start_matches('!') if you want every ! removed.

Examples

use noyalib::Tag;
assert_eq!(Tag::new("!Custom").nobang(), "Custom");
assert_eq!(Tag::new("!!str").nobang(), "!str");
assert_eq!(Tag::new("plain").nobang(), "plain");

Trait Implementations

impl AsRef<str> for Tag

fn as_ref(&self) -> &str

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

impl Clone for Tag

fn clone(&self) -> Tag

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Tag

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

Formats the value using the given formatter.

impl Display for Tag

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

Formats the value using the given formatter.

impl Eq for Tag

impl From<&str> for Tag

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<String> for Tag

fn from(s: String) -> Self

Converts to this type from the input type.

impl Hash for Tag

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 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 PartialEq for Tag

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

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 TryFrom<&[u8]> for Tag

type Error = Utf8Error

The type returned in the event of a conversion error.

fn try_from(bytes: &[u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl Value for Tag

Available on crate feature sval only.

fn stream<'sval, S: Stream<'sval> + ?Sized>( &'sval self, stream: &mut S, ) -> Result

A Tag on its own streams as plain text (the tag string). The richer “tag-around-value” shape is in [impl sval::Value for TaggedValue].

fn tag(&self) -> Option<Tag>

Get the tag of this value, if there is one.

fn to_bool(&self) -> Option<bool>

Try convert this value into a boolean.

fn to_f32(&self) -> Option<f32>

Try convert this value into a 32bit binary floating point number.

fn to_f64(&self) -> Option<f64>

Try convert this value into a 64bit binary floating point number.

fn to_i8(&self) -> Option<i8>

Try convert this value into a signed 8bit integer.

fn to_i16(&self) -> Option<i16>

Try convert this value into a signed 16bit integer.

fn to_i32(&self) -> Option<i32>

Try convert this value into a signed 32bit integer.

fn to_i64(&self) -> Option<i64>

Try convert this value into a signed 64bit integer.

fn to_i128(&self) -> Option<i128>

Try convert this value into a signed 128bit integer.

fn to_u8(&self) -> Option<u8>

Try convert this value into an unsigned 8bit integer.

fn to_u16(&self) -> Option<u16>

Try convert this value into an unsigned 16bit integer.

fn to_u32(&self) -> Option<u32>

Try convert this value into an unsigned 32bit integer.

fn to_u64(&self) -> Option<u64>

Try convert this value into an unsigned 64bit integer.

fn to_u128(&self) -> Option<u128>

Try convert this value into an unsigned 128bit integer.

fn to_text(&self) -> Option<&str>

Try convert this value into a text string.

fn to_binary(&self) -> Option<&[u8]>

Try convert this value into a bitstring.