Struct SourceLocation 

pub struct SourceLocation {
    pub repository: PathBuf,
    pub file_path: PathBuf,
    pub line: usize,
    pub git_ref: Option<String>,
}

Tracks the file origin of an item for error reporting.

Fields

repository: PathBuf

Repository path (absolute).

file_path: PathBuf

Relative path within repository.

line: usize

Line number where item definition starts (1-indexed).

git_ref: Option<String>

Optional Git commit/branch if reading from history.

Implementations

impl SourceLocation

pub fn new( repository: impl Into<PathBuf>, file_path: impl Into<PathBuf>, line: usize, ) -> Self

Creates a new SourceLocation.

pub fn with_git_ref( repository: impl Into<PathBuf>, file_path: impl Into<PathBuf>, line: usize, git_ref: impl Into<String>, ) -> Self

Creates a new SourceLocation with a Git reference.

pub fn full_path(&self) -> PathBuf

Returns the full path to the file.

pub fn display(&self) -> String

Format as “path/to/file.md:42”.

pub fn display_full(&self) -> String

Format with repository prefix.

Trait Implementations

impl Clone for SourceLocation

fn clone(&self) -> SourceLocation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SourceLocation

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SourceLocation

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SourceLocation

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

Formats the value using the given formatter.

impl Serialize for SourceLocation

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.