Struct ValueMeta 

#[non_exhaustive]
pub struct ValueMeta<'a> { /* private fields */ }

Metadata associated with a value being deserialized.

This includes documentation comments and type tags from formats that support them (like Styx). For formats that don’t provide metadata (like JSON), these will be empty/none.

Use ValueMeta::builder() to construct instances.

Implementations

impl<'a> ValueMeta<'a>

pub const fn empty() -> Self

A const empty ValueMeta for use as a default reference.

pub fn builder() -> ValueMetaBuilder<'a>

Create a new builder for ValueMeta.

pub fn doc(&self) -> Option<&[Cow<'a, str>]>

Get the documentation comments, if any.

pub fn tag(&self) -> Option<&Cow<'a, str>>

Get the type tag, if any (e.g., @string in Styx).

pub fn span(&self) -> Option<Span>

Get the span where this value starts (e.g., where a VariantTag was found).

pub fn is_empty(&self) -> bool

Returns true if this metadata has no content.

Trait Implementations

impl<'a> Clone for ValueMeta<'a>

fn clone(&self) -> ValueMeta<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ValueMeta<'a>

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

Formats the value using the given formatter.

impl<'a> Default for ValueMeta<'a>

fn default() -> ValueMeta<'a>

Returns the “default value” for a type.

impl<'a> From<&'a ValueMeta<'a>> for MetaSource<'a>

fn from(meta: &'a ValueMeta<'a>) -> Self

Converts to this type from the input type.

impl<'a> From<ValueMeta<'a>> for MetaSource<'a>

fn from(meta: ValueMeta<'a>) -> Self

Converts to this type from the input type.

impl<'a> PartialEq for ValueMeta<'a>

fn eq(&self, other: &ValueMeta<'a>) -> 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> Eq for ValueMeta<'a>

impl<'a> StructuralPartialEq for ValueMeta<'a>