Struct miette::SourceOffset

source ·

pub struct SourceOffset(_);

Expand description

Newtype that represents the ByteOffset from the beginning of a SourceCode

Implementations

source

impl SourceOffset

source

pub fn offset(&self) -> ByteOffset

Actual byte offset.

source

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.

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

source

impl Clone for SourceOffset

source

fn clone(&self) -> SourceOffset

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for SourceOffset

source

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

Formats the value using the given formatter. Read more

source

impl From<SourceOffset> for SourceSpan

source

fn from(offset: SourceOffset) -> Self

Converts to this type from the input type.

source

impl From<usize> for SourceOffset

source

fn from(bytes: ByteOffset) -> Self

Converts to this type from the input type.

source

impl Hash for SourceOffset

source

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more

1.3.0 · source

fn hash_slice<H>(data: &[Self], state: &mut H)where
H: Hasher,
Self: Sized,

Feeds a slice of this type into the given Hasher. Read more

source

impl PartialEq<SourceOffset> for SourceOffset

source

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

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

1.0.0 · source

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more

source

impl StructuralPartialEq 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

source

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

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<D> OwoColorize for D

source

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>where
C: Color,

Set the foreground color generically Read more

source

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>where
C: Color,

Set the background color generically. Read more

source

fn black<'a>(&'a self) -> FgColorDisplay<'a, Black, Self>

Change the foreground color to black

source

fn on_black<'a>(&'a self) -> BgColorDisplay<'a, Black, Self>

Change the background color to black

source

fn red<'a>(&'a self) -> FgColorDisplay<'a, Red, Self>

Change the foreground color to red

source

fn on_red<'a>(&'a self) -> BgColorDisplay<'a, Red, Self>

Change the background color to red

source

fn green<'a>(&'a self) -> FgColorDisplay<'a, Green, Self>

Change the foreground color to green

source

fn on_green<'a>(&'a self) -> BgColorDisplay<'a, Green, Self>

Change the background color to green

source

fn yellow<'a>(&'a self) -> FgColorDisplay<'a, Yellow, Self>

Change the foreground color to yellow

source

fn on_yellow<'a>(&'a self) -> BgColorDisplay<'a, Yellow, Self>

Change the background color to yellow

source

fn blue<'a>(&'a self) -> FgColorDisplay<'a, Blue, Self>

Change the foreground color to blue

source

fn on_blue<'a>(&'a self) -> BgColorDisplay<'a, Blue, Self>

Change the background color to blue

source

fn magenta<'a>(&'a self) -> FgColorDisplay<'a, Magenta, Self>

Change the foreground color to magenta

source

fn on_magenta<'a>(&'a self) -> BgColorDisplay<'a, Magenta, Self>

Change the background color to magenta

source

fn purple<'a>(&'a self) -> FgColorDisplay<'a, Magenta, Self>

Change the foreground color to purple

source

fn on_purple<'a>(&'a self) -> BgColorDisplay<'a, Magenta, Self>

Change the background color to purple

source

fn cyan<'a>(&'a self) -> FgColorDisplay<'a, Cyan, Self>

Change the foreground color to cyan

source

fn on_cyan<'a>(&'a self) -> BgColorDisplay<'a, Cyan, Self>

Change the background color to cyan

source

fn white<'a>(&'a self) -> FgColorDisplay<'a, White, Self>

Change the foreground color to white

source

fn on_white<'a>(&'a self) -> BgColorDisplay<'a, White, Self>

Change the background color to white

source

fn default_color<'a>(&'a self) -> FgColorDisplay<'a, Default, Self>

Change the foreground color to the terminal default

source

fn on_default_color<'a>(&'a self) -> BgColorDisplay<'a, Default, Self>

Change the background color to the terminal default

source

fn bright_black<'a>(&'a self) -> FgColorDisplay<'a, BrightBlack, Self>

Change the foreground color to bright black

source

fn on_bright_black<'a>(&'a self) -> BgColorDisplay<'a, BrightBlack, Self>

Change the background color to bright black

source

fn bright_red<'a>(&'a self) -> FgColorDisplay<'a, BrightRed, Self>

Change the foreground color to bright red

source

fn on_bright_red<'a>(&'a self) -> BgColorDisplay<'a, BrightRed, Self>

Change the background color to bright red

source

fn bright_green<'a>(&'a self) -> FgColorDisplay<'a, BrightGreen, Self>

Change the foreground color to bright green

source

fn on_bright_green<'a>(&'a self) -> BgColorDisplay<'a, BrightGreen, Self>

Change the background color to bright green

source

fn bright_yellow<'a>(&'a self) -> FgColorDisplay<'a, BrightYellow, Self>

Change the foreground color to bright yellow

source

fn on_bright_yellow<'a>(&'a self) -> BgColorDisplay<'a, BrightYellow, Self>

Change the background color to bright yellow

source

fn bright_blue<'a>(&'a self) -> FgColorDisplay<'a, BrightBlue, Self>

Change the foreground color to bright blue

source

fn on_bright_blue<'a>(&'a self) -> BgColorDisplay<'a, BrightBlue, Self>

Change the background color to bright blue

source

fn bright_magenta<'a>(&'a self) -> FgColorDisplay<'a, BrightMagenta, Self>

Change the foreground color to bright magenta

source

fn on_bright_magenta<'a>(&'a self) -> BgColorDisplay<'a, BrightMagenta, Self>

Change the background color to bright magenta

source

fn bright_purple<'a>(&'a self) -> FgColorDisplay<'a, BrightMagenta, Self>

Change the foreground color to bright purple

source

fn on_bright_purple<'a>(&'a self) -> BgColorDisplay<'a, BrightMagenta, Self>

Change the background color to bright purple

source

fn bright_cyan<'a>(&'a self) -> FgColorDisplay<'a, BrightCyan, Self>

Change the foreground color to bright cyan

source

fn on_bright_cyan<'a>(&'a self) -> BgColorDisplay<'a, BrightCyan, Self>

Change the background color to bright cyan

source

fn bright_white<'a>(&'a self) -> FgColorDisplay<'a, BrightWhite, Self>

Change the foreground color to bright white

source

fn on_bright_white<'a>(&'a self) -> BgColorDisplay<'a, BrightWhite, Self>

Change the background color to bright white

source

fn bold<'a>(&'a self) -> BoldDisplay<'a, Self>

Make the text bold

source

fn dimmed<'a>(&'a self) -> DimDisplay<'a, Self>

Make the text dim

source

fn italic<'a>(&'a self) -> ItalicDisplay<'a, Self>

Make the text italicized

source

fn underline<'a>(&'a self) -> UnderlineDisplay<'a, Self>

Make the text italicized

source

fn blink<'a>(&'a self) -> BlinkDisplay<'a, Self>

Make the text blink

source

fn blink_fast<'a>(&'a self) -> BlinkFastDisplay<'a, Self>

Make the text blink (but fast!)

source

fn reversed<'a>(&'a self) -> ReversedDisplay<'a, Self>

Swap the foreground and background colors

source

fn hidden<'a>(&'a self) -> HiddenDisplay<'a, Self>

Hide the text

source

fn strikethrough<'a>(&'a self) -> StrikeThroughDisplay<'a, Self>

Cross out the text

source

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>where
Color: DynColor,

Set the foreground color at runtime. Only use if you do not know which color will be used at compile-time. If the color is constant, use either OwoColorize::fg or a color-specific method, such as OwoColorize::green, Read more

source

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>where
Color: DynColor,

Set the background color at runtime. Only use if you do not know what color to use at compile-time. If the color is constant, use either OwoColorize::bg or a color-specific method, such as OwoColorize::on_yellow, Read more

source

fn fg_rgb<const R: u8, const G: u8, const B: u8>(
&self
) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the foreground color to a specific RGB value.

source

fn bg_rgb<const R: u8, const G: u8, const B: u8>(
&self
) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the background color to a specific RGB value.

source

fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>

Sets the foreground color to an RGB value.

source

fn on_truecolor(&self, r: u8, g: u8, b: u8) -> BgDynColorDisplay<'_, Rgb, Self>

Sets the background color to an RGB value.

source

fn style(&self, style: Style) -> Styled<&Self>

Apply a runtime-determined style

source

impl<T> ToOwned for Twhere
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

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

source

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

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

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct miette::SourceOffset

Implementations

impl SourceOffset

pub fn offset(&self) -> ByteOffset

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

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

Trait Implementations

impl Clone for SourceOffset

fn clone(&self) -> SourceOffset

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

impl Debug for SourceOffset

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

impl From<SourceOffset> for SourceSpan

fn from(offset: SourceOffset) -> Self

impl From<usize> for SourceOffset

fn from(bytes: ByteOffset) -> Self

impl Hash for SourceOffset

fn hash<__H: Hasher>(&self, state: &mut __H)

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

impl PartialEq<SourceOffset> for SourceOffset

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

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

impl Copy for SourceOffset

impl Eq for SourceOffset

impl StructuralEq for SourceOffset

impl StructuralPartialEq 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 Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

impl<D> OwoColorize for D

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>where C: Color,

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>where C: Color,

fn black<'a>(&'a self) -> FgColorDisplay<'a, Black, Self>

fn on_black<'a>(&'a self) -> BgColorDisplay<'a, Black, Self>

fn red<'a>(&'a self) -> FgColorDisplay<'a, Red, Self>

fn on_red<'a>(&'a self) -> BgColorDisplay<'a, Red, Self>

fn green<'a>(&'a self) -> FgColorDisplay<'a, Green, Self>

fn on_green<'a>(&'a self) -> BgColorDisplay<'a, Green, Self>

fn yellow<'a>(&'a self) -> FgColorDisplay<'a, Yellow, Self>

fn on_yellow<'a>(&'a self) -> BgColorDisplay<'a, Yellow, Self>

fn blue<'a>(&'a self) -> FgColorDisplay<'a, Blue, Self>

fn on_blue<'a>(&'a self) -> BgColorDisplay<'a, Blue, Self>

fn magenta<'a>(&'a self) -> FgColorDisplay<'a, Magenta, Self>

fn on_magenta<'a>(&'a self) -> BgColorDisplay<'a, Magenta, Self>

fn purple<'a>(&'a self) -> FgColorDisplay<'a, Magenta, Self>

fn on_purple<'a>(&'a self) -> BgColorDisplay<'a, Magenta, Self>

fn cyan<'a>(&'a self) -> FgColorDisplay<'a, Cyan, Self>

fn on_cyan<'a>(&'a self) -> BgColorDisplay<'a, Cyan, Self>

fn white<'a>(&'a self) -> FgColorDisplay<'a, White, Self>

fn on_white<'a>(&'a self) -> BgColorDisplay<'a, White, Self>

fn default_color<'a>(&'a self) -> FgColorDisplay<'a, Default, Self>

fn on_default_color<'a>(&'a self) -> BgColorDisplay<'a, Default, Self>

fn bright_black<'a>(&'a self) -> FgColorDisplay<'a, BrightBlack, Self>

fn on_bright_black<'a>(&'a self) -> BgColorDisplay<'a, BrightBlack, Self>

fn bright_red<'a>(&'a self) -> FgColorDisplay<'a, BrightRed, Self>

fn on_bright_red<'a>(&'a self) -> BgColorDisplay<'a, BrightRed, Self>

fn bright_green<'a>(&'a self) -> FgColorDisplay<'a, BrightGreen, Self>

fn on_bright_green<'a>(&'a self) -> BgColorDisplay<'a, BrightGreen, Self>

fn bright_yellow<'a>(&'a self) -> FgColorDisplay<'a, BrightYellow, Self>

fn on_bright_yellow<'a>(&'a self) -> BgColorDisplay<'a, BrightYellow, Self>

fn bright_blue<'a>(&'a self) -> FgColorDisplay<'a, BrightBlue, Self>

fn on_bright_blue<'a>(&'a self) -> BgColorDisplay<'a, BrightBlue, Self>

fn bright_magenta<'a>(&'a self) -> FgColorDisplay<'a, BrightMagenta, Self>

fn on_bright_magenta<'a>(&'a self) -> BgColorDisplay<'a, BrightMagenta, Self>

fn bright_purple<'a>(&'a self) -> FgColorDisplay<'a, BrightMagenta, Self>

fn on_bright_purple<'a>(&'a self) -> BgColorDisplay<'a, BrightMagenta, Self>

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

fn hash<H: Hasher>(&self, state: &mut H)

fn hash_slice<H>(data: &[Self], state: &mut H)where
H: Hasher,
Self: Sized,

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

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

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

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

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>where
C: Color,

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>where
C: Color,

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>where
Color: DynColor,

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>where
Color: DynColor,

fn fg_rgb<const R: u8, const G: u8, const B: u8>(
&self
) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>

fn bg_rgb<const R: u8, const G: u8, const B: u8>(
&self
) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>

impl<T> ToOwned for Twhere
T: Clone,

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

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