Struct toml::Spanned

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

A spanned value, indicating the range at which it is defined in the source.

Implementations

impl<T> Spanned<T>

pub fn new(range: Range<usize>, value: T) -> Spanned<T>

Create a spanned value encompassing the given byte range.

Example

Transposing a Spanned<Enum<T>> into Enum<Spanned<T>>:

use serde::de::{Deserialize, Deserializer};
use serde_untagged::UntaggedEnumVisitor;
use toml::Spanned;

pub enum Dependency {
    Simple(Spanned<String>),
    Detailed(Spanned<DetailedDependency>),
}

impl<'de> Deserialize<'de> for Dependency {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: Deserializer<'de>,
    {
        enum DependencyKind {
            Simple(String),
            Detailed(DetailedDependency),
        }

        impl<'de> Deserialize<'de> for DependencyKind {
            fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
            where
                D: Deserializer<'de>,
            {
                UntaggedEnumVisitor::new()
                    .expecting(
                        "a version string like \"0.9.8\" or a \
                            detailed dependency like { version = \"0.9.8\" }",
                    )
                    .string(|value| Ok(DependencyKind::Simple(value.to_owned())))
                    .map(|value| value.deserialize().map(DependencyKind::Detailed))
                    .deserialize(deserializer)
            }
        }

        let spanned: Spanned<DependencyKind> = Deserialize::deserialize(deserializer)?;
        let range = spanned.span();
        Ok(match spanned.into_inner() {
            DependencyKind::Simple(simple) => Dependency::Simple(Spanned::new(range, simple)),
            DependencyKind::Detailed(detailed) => Dependency::Detailed(Spanned::new(range, detailed)),
        })
    }
}

pub fn span(&self) -> Range<usize>

Byte range

pub fn into_inner(self) -> T

Consumes the spanned value and returns the contained value.

pub fn get_ref(&self) -> &T

Returns a reference to the contained value.

pub fn get_mut(&mut self) -> &mut T

Returns a mutable reference to the contained value.

Trait Implementations

impl<T> AsMut<T> for Spanned<T>

fn as_mut(&mut self) -> &mut T

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

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

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl<T> Clone for Spanned<T>

where T: Clone,

fn clone(&self) -> Spanned<T>

Returns a copy 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<(), Error>

Formats the value using the given formatter.

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

where T: Deserialize<'de>,

fn deserialize<D>( deserializer: D, ) -> Result<Spanned<T>, <D as Deserializer<'de>>::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>(&self, state: &mut H)

where H: Hasher,

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<T> Ord for Spanned<T>

where T: Ord,

fn cmp(&self, other: &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 + PartialOrd,

Restrict a value to a certain interval.

impl<T> PartialEq for Spanned<T>

where T: PartialEq,

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

where T: PartialOrd,

fn partial_cmp(&self, other: &Spanned<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T> Serialize for Spanned<T>

where T: Serialize,

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> Eq for Spanned<T>

where T: Eq,