Struct Spanned 

pub struct Spanned<T> {
    pub value: T,
    pub span: Span,
}

Wraps a value T with its source Span.

Use this as a field type in your Deserialize structs when you need to preserve span information alongside the deserialized value.

Examples

use toml_spanner::{Arena, Spanned};

let arena = Arena::new();
let mut table = toml_spanner::parse("name = \"hello\"", &arena)?;
let name: Spanned<String> = table.required("name")?;
assert_eq!(name.value, "hello");
assert!(name.span.start < name.span.end);

Fields

value: T

The deserialized value.

span: Span

The byte-offset span in the source document.

Implementations

impl<T> Spanned<T>

pub const fn new(value: T) -> Self

Creates a Spanned with the given value and a zero span.

pub const fn with_span(value: T, span: Span) -> Self

Creates a Spanned from a value and a Span.

pub fn take(self) -> T

Consumes the wrapper, returning the inner value.

pub fn map<V>(self) -> Spanned<V>

where V: From<T>,

Maps the inner value via From, preserving the span.

Trait Implementations

impl<T> AsRef<T> for Spanned<T>

fn as_ref(&self) -> &T

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

impl<T> Clone for Spanned<T>

where T: Clone,

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Spanned<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> Default for Spanned<T>

where T: Default,

fn default() -> Self

Returns the “default value” for a type.

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

where T: Deserialize<'de>,

fn deserialize(value: &mut Item<'de>) -> Result<Self, Error>

Deserializes Self from the given Item, returning an error on failure.

impl<T> Ord for Spanned<T>

where T: Ord,

fn cmp(&self, o: &Spanned<T>) -> 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 Spanned<T>

where T: PartialEq,

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

where T: PartialEq,

fn eq(&self, o: &Spanned<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<T> PartialOrd for Spanned<T>

where T: PartialOrd,

fn partial_cmp(&self, o: &Spanned<T>) -> 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<T> Eq for Spanned<T>

where T: Eq,