Struct marked_yaml::Spanned

pub struct Spanned<T> { /* private fields */ }

Available on crate feature serde only.

Wrapper which can be used when deserialising data from Node

You must use a compatible deserializer if you want to deserialize these values.

use marked_yaml::{from_yaml, Spanned};
use serde::Deserialize;

#[derive(Deserialize)]
struct MyStuff {
    num: Spanned<u32>,
}
let stuff: MyStuff = from_yaml(0, "num: 12").unwrap();

You can also serialize these values, however when serializing you will lose the span information so do not expect to round-trip these values.

Implementations

impl<T> Spanned<T>

pub fn new(span: Span, inner: T) -> Self

Wrap an instance of something with the given span

let spanned = Spanned::new(Span::new_blank(), "Hello World");

pub fn span(&self) -> &Span

The span associated with this value

let spanned = Spanned::new(span, "Hello World");
assert_eq!(spanned.span(), &span);

Trait Implementations

impl Borrow<str> for Spanned<&str>

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl Borrow<str> for Spanned<String>

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl<T: Debug> Debug for Spanned<T>

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

Formats the value using the given formatter.

impl<T> Deref for Spanned<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de, T> Deserialize<'de> for Spanned<T>

where T: Deserialize<'de>,

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> Hash for Spanned<T>

where T: Hash,

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 PartialEq<&str> for Spanned<String>

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

where T: PartialEq,

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

where T: PartialEq,

fn eq(&self, other: &Self) -> 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<T> Serialize for Spanned<T>

where T: Serialize,

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> Eq for Spanned<T>

where T: Eq,