Struct Loc 

pub struct Loc<T, L> {
    pub inner: T,
    pub loc: L,
}

A value wrapped along with a corresponding source code location.

Typically, Locs should be created using the WithLocation trait.

NOTE This type is designed to be transparent, i.e. it behaves as T in many cases. In particular, comparisons such as Hash, PartialEq, PartialOrd, etc. completely ignore the location and only compare T.

In addition, the type implements Deref<Target=T> which means that Loc<T> can be passed directly to functions which expect &T

Fields

inner: T

loc: L

Implementations

impl<T, L> Loc<T, L>

where L: Location,

pub fn new(inner: T, loc: L) -> Self

pub fn nowhere(inner: T) -> Self

Create a Location which does not correspond to a source code location. Depending on how the lbirary is used in a compiler, this can either be a placeholder value, in which case encountering a nowhere when reporting an error is probably an error, or if source locations can be missing it should be an actual marker.

pub fn strip(self) -> T

Remove the location info

pub fn strip_ref(&self) -> &T

Get a reference to the underlying value

pub fn separate(self) -> (Self, L)

Split into self and the location

pub fn separate_loc(self) -> (Self, Loc<(), L>)

pub fn split(self) -> (T, L)

pub fn split_ref(&self) -> (&T, L)

pub fn split_loc(self) -> (T, Loc<(), L>)

pub fn split_loc_ref(&self) -> (&T, Loc<(), L>)

pub fn map<Y>(self, op: impl FnMut(T) -> Y) -> Loc<Y, L>

pub fn map_ref<Y>(&self, op: impl FnMut(&T) -> Y) -> Loc<Y, L>

pub fn try_map_ref<Y, E, F>(&self, op: F) -> Result<Loc<Y, L>, E>

where F: FnMut(&T) -> Result<Y, E>,

pub fn loc(&self) -> Loc<(), L>

impl<T, L, E> Loc<Result<T, E>, L>

where L: Location,

pub fn map_err<E2>( self, err_fn: impl Fn(E, Loc<(), L>) -> E2, ) -> Result<Loc<T, L>, E2>

Trait Implementations

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

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T, L> Debug for Loc<T, L>

where T: Debug, L: Debug,

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

Formats the value using the given formatter.

impl<T, L> Deref for Loc<T, L>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T, L> DerefMut for Loc<T, L>

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

Mutably dereferences the value.

impl<'de, T, L> Deserialize<'de> for Loc<T, L>

where T: Deserialize<'de>, L: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T, L> Display for Loc<T, L>

where T: Display,

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

Formats the value using the given formatter.

impl<T, L> Hash for Loc<T, L>

where T: Hash,

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T, L> Ord for Loc<T, L>

where T: Ord,

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

Restrict a value to a certain interval.

impl<T, L> PartialEq for Loc<T, L>

where T: PartialEq,

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

where T: PartialOrd,

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<T, L> Serialize for Loc<T, L>

where T: Serialize, L: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: Copy, L: Copy> Copy for Loc<T, L>

impl<T, L> Eq for Loc<T, L>

where T: Eq,