Struct miette::SourceOffset[−][src]

pub struct SourceOffset(_);

Expand description

Newtype that represents the ByteOffset from the beginning of a Source

Implementations

impl SourceOffset

pub 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 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. Read more

1.0.0[src]

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

Performs copy-assignment from source. Read more

impl Debug for SourceOffset

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

Formats the value using the given formatter. Read more

impl From<usize> for SourceOffset

fn from(bytes: ByteOffset) -> Self

Performs the conversion.

impl Copy for SourceOffset

Auto Trait Implementations

impl RefUnwindSafe for SourceOffset

impl Send for SourceOffset

impl Sync for SourceOffset

impl Unpin for SourceOffset

impl UnwindSafe for SourceOffset

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

pub fn from(t: T) -> T

Performs the conversion.

impl<T, U> Into<U> for T where
U: From<T>,

pub fn into(self) -> U

Performs the conversion.

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

pub fn clone_into(&self, target: &mut T)

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

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.