Struct AttachedToken

pub struct AttachedToken(pub TokenWithSpan);

A wrapper over TokenWithSpans that ignores the token and source location in comparisons and hashing.

This type is used when the token and location is not relevant for semantics, but is still needed for accurate source location tracking, for example, in the nodes in the ast module.

Note: All AttachedTokens are equal.

Examples

Same token, different location are equal

// commas @ line 1, column 10
let tok1 = TokenWithLocation::new(
  Token::Comma,
  Span::new(Location::new(1, 10), Location::new(1, 11)),
);
// commas @ line 2, column 20
let tok2 = TokenWithLocation::new(
  Token::Comma,
  Span::new(Location::new(2, 20), Location::new(2, 21)),
);

assert_ne!(tok1, tok2); // token with locations are *not* equal
assert_eq!(AttachedToken(tok1), AttachedToken(tok2)); // attached tokens are

Different token, different location are equal 🤯

// commas @ line 1, column 10
let tok1 = TokenWithLocation::new(
  Token::Comma,
  Span::new(Location::new(1, 10), Location::new(1, 11)),
);
// period @ line 2, column 20
let tok2 = TokenWithLocation::new(
 Token::Period,
  Span::new(Location::new(2, 10), Location::new(2, 21)),
);

assert_ne!(tok1, tok2); // token with locations are *not* equal
assert_eq!(AttachedToken(tok1), AttachedToken(tok2)); // attached tokens are

// period @ line 2, column 20

Tuple Fields

0: TokenWithSpan

Implementations

impl AttachedToken

pub fn empty() -> AttachedToken

Return a new Empty AttachedToken

Trait Implementations

impl Clone for AttachedToken

fn clone(&self) -> AttachedToken

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AttachedToken

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

Formats the value using the given formatter.

impl From<AttachedToken> for TokenWithSpan

fn from(value: AttachedToken) -> TokenWithSpan

Converts to this type from the input type.

impl From<TokenWithSpan> for AttachedToken

fn from(value: TokenWithSpan) -> AttachedToken

Converts to this type from the input type.

impl Hash for AttachedToken

fn hash<H>(&self, _state: &mut H)

where H: Hasher,

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 Ord for AttachedToken

fn cmp(&self, _: &AttachedToken) -> 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 PartialEq for AttachedToken

fn eq(&self, _: &AttachedToken) -> 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 PartialOrd for AttachedToken

fn partial_cmp(&self, other: &AttachedToken) -> 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 Visit for AttachedToken

fn visit<V>(&self, visitor: &mut V) -> ControlFlow<<V as Visitor>::Break>

where V: Visitor,

impl VisitMut for AttachedToken

fn visit<V>(&mut self, visitor: &mut V) -> ControlFlow<<V as VisitorMut>::Break>

where V: VisitorMut,

impl Eq for AttachedToken