Struct miette::SourceOffset[−][src]

pub struct SourceOffset(_);

Expand description

Newtype that represents the ByteOffset from the beginning of a Source

Implementations

[src]

impl SourceOffset

[src]

pub fn offset(&self) -> ByteOffset

Actual byte offset.

[src]

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.

[src]

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

[src]

impl Clone for SourceOffset

[src]

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

[src]

impl Debug for SourceOffset

[src]

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

Formats the value using the given formatter. Read more

[src]

impl From<usize> for SourceOffset

[src]

fn from(bytes: ByteOffset) -> Self

Performs the conversion.

[src]

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

[src]

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

[src]

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

[src]

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

[src]

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

[src]

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

[src]

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

Mutably borrows from an owned value. Read more

[src]

impl<T> From<T> for T

[src]

pub fn from(t: T) -> T

Performs the conversion.

[src]

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

[src]

pub fn into(self) -> U

Performs the conversion.

[src]

impl<D> OwoColorize for D

[src]

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

Set the foreground color generically Read more

[src]

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

Set the background color generically. Read more

[src]

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

Change the foreground color to black

[src]

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

Change the foreground color to black

[src]

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

Change the foreground color to red

[src]

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

Change the foreground color to red

[src]

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

Change the foreground color to green

[src]

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

Change the foreground color to green

[src]

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

Change the foreground color to yellow

[src]

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

Change the foreground color to yellow

[src]

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

Change the foreground color to blue

[src]

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

Change the foreground color to blue

[src]

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

Change the foreground color to magenta

[src]

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

Change the foreground color to magenta

[src]

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

Change the foreground color to purple

[src]

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

Change the foreground color to purple

[src]

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

Change the foreground color to cyan

[src]

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

Change the foreground color to cyan

[src]

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

Change the foreground color to white

[src]

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

Change the foreground color to white

[src]

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

Change the foreground color to bright black

[src]

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

Change the foreground color to bright black

[src]

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

Change the foreground color to bright red

[src]

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

Change the foreground color to bright red

[src]

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

Change the foreground color to bright green

[src]

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

Change the foreground color to bright green

[src]

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

Change the foreground color to bright yellow

[src]

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

Change the foreground color to bright yellow

[src]

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

Change the foreground color to bright blue

[src]

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

Change the foreground color to bright blue

[src]

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

Change the foreground color to bright magenta

[src]

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

Change the foreground color to bright magenta

[src]

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

Change the foreground color to bright purple

[src]

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

Change the foreground color to bright purple

[src]

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

Change the foreground color to bright cyan

[src]

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

Change the foreground color to bright cyan

[src]

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

Change the foreground color to bright white

[src]

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

Change the foreground color to bright white

[src]

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

Make the text bold

[src]

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

Make the text dim

[src]

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

Make the text italicized

[src]

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

Make the text italicized

[src]

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

Make the text blink

[src]

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

Make the text blink (but fast!)

[src]

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

Swap the foreground and background colors

[src]

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

Hide the text

[src]

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

Cross out the text

[src]

fn color<Color>(&'a self, color: Color) -> FgDynColorDisplay<'a, 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

[src]

fn on_color<Color>(&'a self, color: Color) -> BgDynColorDisplay<'a, 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

[src]

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

Set the foreground color to a specific RGB value.

[src]

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

Set the background color to a specific RGB value.

[src]

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

Sets the foreground color to an RGB value.

[src]

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

Sets the background color to an RGB value.

[src]

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

Apply a runtime-determined style

[src]

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

type Owned = T

The resulting type after obtaining ownership.

[src]

pub fn to_owned(&self) -> T

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

[src]

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

[src]

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

type Error = Infallible

The type returned in the event of a conversion error.

[src]

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

Performs the conversion.

[src]

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

type Error = >::Error

The type returned in the event of a conversion error.

[src]

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

Performs the conversion.

Struct miette::SourceOffset[−][src]

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<usize> for SourceOffset

fn from(bytes: ByteOffset) -> Self

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

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

pub fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

pub fn from(t: T) -> T

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

pub fn into(self) -> U

impl<D> OwoColorize for D

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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