Struct gluon_base::pos::BytePos

pub struct BytePos(pub u32);

A byte position in a source file. The index is continuous, running over all files in a CodeMap, starting with 1. Zero is reserved for positions that do not point to a valid file. One byte of padding is added between each file.

For example, for these files:

• main.rs: pub struct (10 bytes)
• lib.rs: Span::new (9 bytes)

ByteIndex(0) points to no file at all, ByteIndex(2) points at the second byte (index 1) in main.rs and ByteIndex(14) points at the third byte (index 2) in lib.rs.

You can visualize the indices like this:

                 main.rs                                     lib.rs

content    │ █ │ p │ u │ b │   │ s │ t │ r │ u │ c │ t │ █ │ S │ p │ a │ n │ : │ : │ n │ e │ w │
───────────┼───┼───┼───┼───┼───┼───┼───┼───┼───┼───┼───┼───┼───┼───┼───┼───┼───┼───┼───┼───┼───┤
file index │ █ │ 0 │ 1 │ 2 │ 3 │ 4 │ 5 │ 6 │ 7 │ 8 │ 9 │ █ │ 0 │ 1 │ 2 │ 3 │ 4 │ 5 │ 6 │ 7 │ 8 │
───────────┼───┼───┼───┼───┼───┼───┼───┼───┼───┼───┼───┼───┼───┼───┼───┼───┼───┼───┼───┼───┼───┤
ByteIndex  │ 0 │ 1 │ 2 │ 3 │ 4 │ 5 │ 6 │ 7 │ 8 │ 9 │10 │11 │12 │13 │14 │15 │16 │17 │18 │19 │20 │

Methods

impl ByteIndex

pub fn none() -> ByteIndex

A byte position that will never point to a valid file

pub fn to_usize(self) -> usize

Convert the position into a usize, for use in array indexing

Trait Implementations

impl Eq for ByteIndex

impl Index for ByteIndex

type Offset = ByteOffset

impl Default for ByteIndex

fn default() -> ByteIndex

Returns the "default value" for a type.

impl Copy for ByteIndex

impl Sub<ByteOffset> for ByteIndex

type Output = ByteIndex

The resulting type after applying the - operator.

fn sub(self, rhs: ByteOffset) -> ByteIndex

Performs the - operation.

impl Sub<ByteIndex> for ByteIndex

type Output = ByteOffset

The resulting type after applying the - operator.

fn sub(self, rhs: ByteIndex) -> ByteOffset

Performs the - operation.

impl SubAssign<ByteOffset> for ByteIndex

fn sub_assign(&mut self, rhs: ByteOffset)

Performs the -= operation.

impl Display for ByteIndex

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

Formats the value using the given formatter.

impl AddAssign<ByteOffset> for ByteIndex

fn add_assign(&mut self, rhs: ByteOffset)

Performs the += operation.

impl Ord for ByteIndex

fn cmp(&self, other: &ByteIndex) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl Clone for ByteIndex

fn clone(&self) -> ByteIndex

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<ByteIndex> for ByteIndex

fn eq(&self, other: &ByteIndex) -> bool

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

fn ne(&self, other: &ByteIndex) -> bool

This method tests for !=.

impl Debug for ByteIndex

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

Formats the value using the given formatter.

impl From<u32> for ByteIndex

fn from(i: u32) -> ByteIndex

Performs the conversion.

impl Add<ByteOffset> for ByteIndex

type Output = ByteIndex

The resulting type after applying the + operator.

fn add(self, rhs: ByteOffset) -> ByteIndex

Performs the + operation.

impl Hash for ByteIndex

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, 

Feeds a slice of this type into the given [Hasher].

impl PartialOrd<ByteIndex> for ByteIndex

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

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

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

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

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

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

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

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

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

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