Struct reporting::File

pub struct File { /* private fields */ }

Information about a file.

Implementations

impl File

pub fn new(path: impl Into<String>, source: impl Into<String>) -> Arc<Self>

Creates a new File with the given path and source.

Examples found in repository

examples/basic.rs (line 4)

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 open(path: impl Into<String>) -> Result<Arc<Self>, Error>

A shorthand method to read a file and create a File from its contents.

pub fn path(&self) -> &str

Returns the file’s path.

pub fn source(&self) -> &str

Returns the file’s source contents.

pub fn line_column(&self, offset: usize) -> Option<(usize, usize)>

Returns the line and column number corresponding to the given offset in the file’s source.

Trait Implementations

impl Clone for File

fn clone(&self) -> File

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for File

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

Formats the value using the given formatter.

impl Hash for File

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 PartialEq for File

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

impl StructuralPartialEq for File