Struct SourceIndex

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

SourceIndex is a compact representation of a byte index in a specific source file.

It has a canonical representation for “unknown” indices, similar to that of [SourceSpan]

Implementations

impl SourceIndex

pub const UNKNOWN: Self

Represents an invalid/unknown SourceIndex

pub fn new(source: SourceId, index: ByteIndex) -> Self

Constructs a new SourceIndex from a SourceId and a ByteIndex

pub fn source_id(&self) -> SourceId

Returns the SourceId corresponding to this SourceIndex

pub fn index(&self) -> ByteIndex

Returns the ByteIndex corresponding to this SourceIndex

Trait Implementations

impl Add<ByteOffset> for SourceIndex

type Output = SourceIndex

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<usize> for SourceIndex

type Output = SourceIndex

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<ByteOffset> for SourceIndex

fn add_assign(&mut self, rhs: ByteOffset)

Performs the += operation.

impl AddAssign<usize> for SourceIndex

fn add_assign(&mut self, rhs: usize)

Performs the += operation.

impl Clone for SourceIndex

fn clone(&self) -> SourceIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SourceIndex

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

Formats the value using the given formatter.

impl Default for SourceIndex

fn default() -> Self

Returns the “default value” for a type.

impl Hash for SourceIndex

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 SourceIndex

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

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

Tests for self and other values to be equal, and is used by ==.

const 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 SourceIndex

fn partial_cmp(&self, other: &SourceIndex) -> 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 Sub<usize> for SourceIndex

type Output = SourceIndex

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<usize> for SourceIndex

fn sub_assign(&mut self, rhs: usize)

Performs the -= operation.

impl Copy for SourceIndex

impl Eq for SourceIndex

impl StructuralPartialEq for SourceIndex