Struct ByteIndex

pub struct ByteIndex(/* private fields */);

An index representing the offset in bytes from the start of a source file

Implementations

impl ByteIndex

pub const fn new(index: u32) -> Self

Create a ByteIndex from a raw u32 index

pub const fn to_usize(self) -> usize

Get the raw index as a usize

pub const fn to_u32(self) -> u32

Get the raw index as a u32

Trait Implementations

impl Add<ByteOffset> for ByteIndex

type Output = ByteIndex

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<u32> for ByteIndex

type Output = ByteIndex

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<ByteOffset> for ByteIndex

fn add_assign(&mut self, rhs: ByteOffset)

Performs the += operation.

impl AddAssign<u32> for ByteIndex

fn add_assign(&mut self, rhs: u32)

Performs the += operation.

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 Debug for ByteIndex

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

Formats the value using the given formatter.

impl Default for ByteIndex

fn default() -> ByteIndex

Returns the “default value” for a type.

impl From<ByteIndex> for u32

fn from(index: ByteIndex) -> Self

Converts to this type from the input type.

impl From<u32> for ByteIndex

fn from(index: u32) -> Self

Converts to this type from the input type.

impl Hash for ByteIndex

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 ByteIndex

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

fn eq(&self, other: &ByteIndex) -> 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 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: &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 RangeBounds<ByteIndex> for SourceSpan

fn start_bound(&self) -> Bound<&ByteIndex>

Start index bound.

fn end_bound(&self) -> Bound<&ByteIndex>

End index bound.

fn contains<U>(&self, item: &U) -> bool

where T: PartialOrd<U>, U: PartialOrd<T> + ?Sized,

Returns true if item is contained in the range.

impl Sub<ByteOffset> for ByteIndex

type Output = ByteIndex

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<u32> for ByteIndex

type Output = ByteIndex

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<ByteOffset> for ByteIndex

fn sub_assign(&mut self, rhs: ByteOffset)

Performs the -= operation.

impl SubAssign<u32> for ByteIndex

fn sub_assign(&mut self, rhs: u32)

Performs the -= operation.

impl Copy for ByteIndex

impl Eq for ByteIndex

impl StructuralPartialEq for ByteIndex