Struct SourceOffset

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

Newtype that represents the ByteOffset from the beginning of a SourceCode

Implementations

impl SourceOffset

pub const fn offset(&self) -> ByteOffset

Actual byte offset.

pub fn from_location( source: impl AsRef<str>, loc_line: usize, loc_col: usize, ) -> Self

Little utility to help convert 1-based line/column locations into miette-compatible Spans

This function is infallible: Giving an out-of-range line/column pair will return the offset of the last byte in the source.

pub fn from_current_location() -> Result<(String, Self), MietteError>

Returns an offset for the file location of wherever this function is called. If you want to get that caller’s location, mark this function’s caller with #[track_caller] (and so on and so forth).

Returns both the filename that was given and the offset of the caller as a SourceOffset.

Keep in mind that this fill only work if the file your Rust source file was compiled from is actually available at that location. If you’re shipping binaries for your application, you’ll want to ignore the Err case or otherwise report it.

Trait Implementations

impl Clone for SourceOffset

fn clone(&self) -> SourceOffset

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SourceOffset

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

Formats the value using the given formatter.

impl From<SourceOffset> for SourceSpan

fn from(offset: SourceOffset) -> Self

Converts to this type from the input type.

impl From<usize> for SourceOffset

fn from(bytes: ByteOffset) -> Self

Converts to this type from the input type.

impl Hash for SourceOffset

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 SourceOffset

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

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

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

impl Eq for SourceOffset

impl StructuralPartialEq for SourceOffset