Struct autumn::Meta

pub struct Meta<T, I> { /* fields omitted */ }

Structure to tag an object with a positional information

This can be used to associate any value with a particular Location or Span within a source text.

Methods

impl<T, I> Meta<T, I>

pub fn inner(self) -> T

Unwrap the meta and return only the inner value

pub fn inner_ref(&self) -> &T

Get a reference to the inner value

pub fn inner_mut(&mut self) -> &mut T

Get a reference to the inner value

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

Split a meta into a separate value and location

pub fn map<A>(self, map: impl FnMut(T) -> A) -> Meta<A, I>

Map the value within the meta

impl<T, I: Clone> Meta<T, I>

pub fn as_ref(&self) -> Meta<&T, I>

Create a new meta referencing the original value

pub fn as_mut(&mut self) -> Meta<&mut T, I>

Create a new meta mutably referencing the original value

impl<T> Meta<T, Location>

pub fn span(self) -> Meta<T, Span>

Turn a meta referring to a single Location to an empty Span starting at the same location.

Trait Implementations

impl<T: Clone, I: Clone> Clone for Meta<T, I>

fn clone(&self) -> Meta<T, I>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Copy, I: Copy> Copy for Meta<T, I>

impl<T: Debug, I: Debug> Debug for Meta<T, I>

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

Formats the value using the given formatter.

impl<T, I> Deref for Meta<T, I>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T, I> DerefMut for Meta<T, I>

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

Mutably dereferences the value.

impl<T: Display, I: Display> Display for Meta<T, I>

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

Formats the value using the given formatter.

impl<T: Eq, I: Eq> Eq for Meta<T, I>

impl<T, I> Error for Meta<T, I> where
    T: Error,
    I: Display + Debug, 

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any.

fn backtrace(&self) -> Option<&Backtrace>

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

Returns a stack backtrace, if available, of where this error occurred.

fn description(&self) -> &str

Deprecated since 1.42.0:

use the Display impl or to_string()

if let Err(e) = "xc".parse::<u32>() { // Print e itself, no need for description(). eprintln!("Error: {}", e); }

fn cause(&self) -> Option<&dyn Error>

Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

impl<T: Ord, I: Ord> Ord for Meta<T, I>

fn cmp(&self, other: &Meta<T, I>) -> 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, E, P: Parser<T, E>> Parser<Meta<T, Span>, E> for MetaMap<P, E>

fn parse<'s>(
    &self,
    source: &'s str,
    location: Span
) -> ParseResult<'s, Meta<T, Span>, E>

impl<T: PartialEq, I: PartialEq> PartialEq<Meta<T, I>> for Meta<T, I>

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

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

fn ne(&self, other: &Meta<T, I>) -> bool

This method tests for !=.

impl<T: PartialOrd, I: PartialOrd> PartialOrd<Meta<T, I>> for Meta<T, I>

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

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

fn lt(&self, other: &Meta<T, I>) -> bool

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

fn le(&self, other: &Meta<T, I>) -> bool

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

fn gt(&self, other: &Meta<T, I>) -> bool

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

fn ge(&self, other: &Meta<T, I>) -> bool

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

impl<T, I> StructuralEq for Meta<T, I>

impl<T, I> StructuralPartialEq for Meta<T, I>