Struct reporting::Location

pub struct Location { /* private fields */ }

A location in a file.

Implementations

impl Location

pub fn new(file: Arc<File>, offset: usize) -> Self

Creates a new Location with the given file and offset.

Panics

Panics if the given offset is out of bounds for the file’s source.

Examples found in repository

examples/basic.rs (line 13)

fn main() {
    let file = File::new("test.txt", "import stds;");
    let styles = Styles::styled();

    print!(
        "{}",
        Renderer::new(
            &styles,
            &[
                error!("Could not find package `{}`", "stds")
                    .location(Location::new(file.clone(), 7)),
                note!("Perhaps you meant `std`?")
            ]
        )
    );
}

pub fn try_new(file: Arc<File>, offset: usize) -> Option<Self>

Attempts to create a Location with the given file and offset, returning None if the offset is out of bounds.

pub fn file(&self) -> Arc<File>

Returns the file that contains this source location.

pub fn offset(&self) -> usize

Returns the byte offset of this source location within its file.

pub fn line_column(&self) -> (usize, usize)

Returns the line and column number of this source location within its file.

Trait Implementations

impl Clone for Location

fn clone(&self) -> Location

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Location

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

Formats the value using the given formatter.

impl PartialEq for Location

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

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

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.

impl Eq for Location

impl StructuralPartialEq for Location