Struct BytePos

pub struct BytePos(pub u32);

A byte offset. Keep this small (currently 32-bits), as AST contains a lot of them.

Reserved

• 0 is reserved for dummy spans. It means BytePos(0) means the BytePos is synthesized by the compiler.

• Values larger than u32::MAX - 2^16 are reserved for the comments.

u32::MAX is special value used to generate source map entries.

Tuple Fields

0: u32

Implementations

impl BytePos

pub const DUMMY: Self = _

Dummy position. This is reserved for synthesized spans.

pub const PLACEHOLDER: Self = _

Placeholders, commonly used where names are required, but the names are not referenced elsewhere.

pub const PURE: Self = _

Reserved for PURE comments. e.g. /* #__PURE__ */

pub const SYNTHESIZED: Self = _

Synthesized, but should be stored in a source map.

pub const fn is_reserved_for_comments(self) -> bool

pub const fn is_dummy(self) -> bool

Returns `true`` if this is synthesized and has no relevant input source code.

pub const fn is_pure(self) -> bool

pub const fn is_placeholder(self) -> bool

pub const fn can_have_comment(self) -> bool

Returns `true`` if this is explicitly synthesized or has relevant input source so can have a comment.

Trait Implementations

impl Add<BytePos> for NonNarrowChar

type Output = NonNarrowChar

The resulting type after applying the + operator.

fn add(self, rhs: BytePos) -> Self

Performs the + operation.

impl Add for BytePos

type Output = BytePos

The resulting type after applying the + operator.

fn add(self, rhs: BytePos) -> BytePos

Performs the + operation.

impl Archive for BytePos

type Archived = ArchivedBytePos

The archived representation of this type.

type Resolver = BytePosResolver

The resolver for this type. It must contain all the additional information from serializing needed to make the archived type from the normal type.

unsafe fn resolve( &self, pos: usize, resolver: Self::Resolver, out: *mut Self::Archived, )

Creates the archived version of this value at the given position and writes it to the given output.

impl Clone for BytePos

fn clone(&self) -> BytePos

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BytePos

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

Formats the value using the given formatter.

impl Default for BytePos

fn default() -> BytePos

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for BytePos

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<__D: Fallible + ?Sized> Deserialize<BytePos, __D> for Archived<BytePos>

fn deserialize(&self, deserializer: &mut __D) -> Result<BytePos, __D::Error>

Deserializes using the given deserializer

impl EqIgnoreSpan for BytePos

fn eq_ignore_span(&self, other: &Self) -> bool

impl Hash for BytePos

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

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

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

fn partial_cmp(&self, other: &BytePos) -> 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<__S: Fallible + ?Sized> Serialize<__S> for BytePos

fn serialize(&self, serializer: &mut __S) -> Result<Self::Resolver, __S::Error>

Writes the dependencies for the object and returns a resolver that can create the archived type.

impl Serialize for BytePos

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl SmallPos for BytePos

fn from_usize(n: usize) -> BytePos

fn to_usize(&self) -> usize

fn from_u32(n: u32) -> BytePos

fn to_u32(&self) -> u32

impl Spanned for BytePos

fn span(&self) -> Span

Creates a new single-byte span.

fn span_lo(&self) -> BytePos

fn span_hi(&self) -> BytePos

impl Sub<BytePos> for NonNarrowChar

type Output = NonNarrowChar

The resulting type after applying the - operator.

fn sub(self, rhs: BytePos) -> Self

Performs the - operation.

impl Sub for BytePos

type Output = BytePos

The resulting type after applying the - operator.

fn sub(self, rhs: BytePos) -> BytePos

Performs the - operation.

impl TypeEq for BytePos

fn type_eq(&self, other: &Self) -> bool

Note: This method should return true for non-type values.

impl Copy for BytePos

impl Eq for BytePos

impl StructuralPartialEq for BytePos