Struct source_span::Loc

pub struct Loc<T: ?Sized> { /* fields omitted */ }

Located data.

This is a simple wrapper around data that can be located in a source file. It is useful to wrap abstract syntax tree nodes.

It derefs into the inner value.

Implementations

impl<T: ?Sized> Loc<T>

pub fn new(t: T, span: Span) -> Loc<T> where
    T: Sized, 

Associate a span location to some data by wrapping it under Loc.

pub fn span(&self) -> Span

Get the span location of the data.

pub fn into_inner(self) -> T where
    T: Sized, 

Unwrap the data.

pub fn into_raw_parts(self) -> (T, Span) where
    T: Sized, 

Break the wrapper into the value and its location.

Trait Implementations

impl<T> AsMut<T> for Loc<T>

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

Performs the conversion.

impl<T> AsRef<T> for Loc<T>

fn as_ref(&self) -> &T

Performs the conversion.

impl<T: Clone> Clone for Loc<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Loc<T>

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

Formats the value using the given formatter.

impl<T> Deref for Loc<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T> DerefMut for Loc<T>

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

Mutably dereferences the value.

impl<T: Display> Display for Loc<T>

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

Formats the value using the given formatter.

impl<T: Eq> Eq for Loc<T>

impl<T: Hash> Hash for Loc<T>

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, 

Feeds a slice of this type into the given [Hasher].

impl<T: Ord> Ord for Loc<T>

fn cmp(&self, other: &Loc<T>) -> Ordering

This method returns an [Ordering] between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq<Loc<T>> for Loc<T>

fn eq(&self, other: &Loc<T>) -> bool

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

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

This method tests for !=.

impl<T: PartialOrd> PartialOrd<Loc<T>> for Loc<T>

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

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

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

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

#[must_use]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]fn gt(&self, other: &Rhs) -> bool

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

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

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