Struct FileLocation 

pub struct FileLocation {
    pub path: Option<PathBuf>,
    pub line: Option<usize>,
    pub column: Option<usize>,
}

Location inside an input artefact, used by structured diagnostics.

Fields are 1-based when present (matching the convention of common text editors and the format specifications themselves). path is None when the input was a buffer rather than a named file.

Examples

use siderust::formats::FileLocation;
let loc = FileLocation::new(Some("/data/igs.sp3".into()), Some(42), Some(7));
assert_eq!(loc.line, Some(42));
assert_eq!(loc.column, Some(7));
assert!(loc.path.as_ref().unwrap().ends_with("igs.sp3"));

Fields

path: Option<PathBuf>

Filesystem path, when known.

line: Option<usize>

1-based line number, when known.

column: Option<usize>

1-based column number, when known.

Implementations

impl FileLocation

pub fn new( path: Option<PathBuf>, line: Option<usize>, column: Option<usize>, ) -> Self

Build a FileLocation from optional fields.

Examples

use siderust::formats::FileLocation;
let loc = FileLocation::new(None, Some(1), None);
assert!(loc.path.is_none());

pub fn at_line(line: usize) -> Self

Build a buffer-anchored location with just a line number.

Examples

use siderust::formats::FileLocation;
let loc = FileLocation::at_line(17);
assert_eq!(loc.line, Some(17));

Trait Implementations

impl Clone for FileLocation

fn clone(&self) -> FileLocation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileLocation

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

Formats the value using the given formatter.

impl Default for FileLocation

fn default() -> FileLocation

Returns the “default value” for a type.

impl Display for FileLocation

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

Formats the value using the given formatter.

impl Eq for FileLocation

impl PartialEq for FileLocation

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