Struct toml::Spanned

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

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

use serde_derive::Deserialize;
use toml::Spanned;

#[derive(Deserialize)]
struct Value {
    s: Spanned<String>,
}

fn main() {
    let t = "s = \"value\"\n";

    let u: Value = toml::from_str(t).unwrap();

    assert_eq!(u.s.start(), 4);
    assert_eq!(u.s.end(), 11);
    assert_eq!(u.s.get_ref(), "value");
    assert_eq!(u.s.into_inner(), String::from("value"));
}

Implementations

impl<T> Spanned<T>

pub fn start(&self) -> usize

Access the start of the span of the contained value.

pub fn end(&self) -> usize

Access the end of the span of the contained value.

pub fn span(&self) -> (usize, usize)

Get the span of the contained value.

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

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl<T: Clone> Clone for Spanned<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

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::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<T: Hash> Hash for Spanned<T>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<T: Ord> Ord for Spanned<T>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

#[must_use]

pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]

pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]

pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq<Spanned<T>> for Spanned<T>

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

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

This method tests for !=.

impl<T: PartialOrd> PartialOrd<Spanned<T>> for Spanned<T>

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

pub 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> Serialize for Spanned<T>

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