Struct Loc

pub struct Loc<T>(/* private fields */);

Represents a T with a Location.

This is commonly used to represent bits of a parse tree, remembering where they came from in the source code.

Loc::unwrap(self) or *self unwraps the T. Loc::location(&self) returns the Location.

Implementations

impl<T> Loc<T>

pub fn new(value: T, location: impl Into<Location>) -> Self

Annotate value with location.

pub fn unwrap(self) -> T

Discards the Location.

pub fn location(&self) -> Location

Returns the Location of self.

If you call this as Loc::location(&self) then there is no risk of confusing with (*self).location

Trait Implementations

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) -> &Self::Target

Dereferences the value.

impl<T> DerefMut for Loc<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

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

fn eq(&self, other: &U) -> 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: Copy> Copy for Loc<T>