# Struct toml::Spanned

source · [−]

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

Expand description

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>,
    }

    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

source

### impl<T> Spanned<T>

source

#### pub fn start(&self) -> usize

Access the start of the span of the contained value.

source

#### pub fn end(&self) -> usize

Access the end of the span of the contained value.

source

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

Get the span of the contained value.

source

#### pub fn into_inner(self) -> T

Consumes the spanned value and returns the contained value.

source

#### pub fn get_ref(&self) -> &T

Returns a reference to the contained value.

source

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

Returns a mutable reference to the contained value.

## Trait Implementations

source

### impl Borrow<str> for Spanned<String>

source

#### fn borrow(&self) -> &str

Immutably borrows from an owned value. Read more

source

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

source

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

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from `source`. Read more

source

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

source

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

Formats the value using the given formatter. Read more

source

### impl<'de, T> Deserialize<'de> for Spanned<T> where
T: Deserialize<'de>,

source

#### fn deserialize<D>(deserializer: D) -> Result<Spanned<T>, D::Error> where
D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

source

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

source

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

Feeds this value into the given `Hasher`. Read more

1.3.0 · source

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

Feeds a slice of this type into the given `Hasher`. Read more

source

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

source

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

This method returns an `Ordering` between `self` and `other`. Read more

1.21.0 · source

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

Compares and returns the maximum of two values. Read more

1.21.0 · source

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

Compares and returns the minimum of two values. Read more

1.50.0 · source

#### fn clamp(self, min: Self, max: Self) -> Self where
Self: PartialOrd<Self>,

Restrict a value to a certain interval. Read more

source

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

source

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

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

1.0.0 · source

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

This method tests for `!=`.

source

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

source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

source

### impl<T: Serialize> Serialize for Spanned<T>

source

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

Serialize this value into the given Serde serializer. Read more

source

### impl<T: Eq> Eq for Spanned<T>

## Auto Trait Implementations

### impl<T> RefUnwindSafe for Spanned<T> where
T: RefUnwindSafe,

### impl<T> Send for Spanned<T> where
T: Send,

### impl<T> Sync for Spanned<T> where
T: Sync,

### impl<T> Unpin for Spanned<T> where
T: Unpin,

### impl<T> UnwindSafe for Spanned<T> where
T: UnwindSafe,

## Blanket Implementations

source

### impl<T> Any for T where
T: 'static + ?Sized,

source

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more

source

### impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

### impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

### impl<T> From<T> for T

const: unstable · source

#### fn from(t: T) -> T

Returns the argument unchanged.

source

### impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

#### fn into(self) -> U

Calls `U::from(self)`.

That is, this conversion is whatever the implementation of `From<T> for U` chooses to do.

source

### impl<T> ToOwned for T where
T: Clone,

#### type Owned = T

The resulting type after obtaining ownership.

source

#### fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

#### fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

### impl<T, U> TryFrom<U> for T where
U: Into<T>,

#### type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

source

### impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

#### type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

source

### impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,