Struct YoshiLocation

pub struct YoshiLocation {
    pub file: &'static str,
    pub line: u32,
    pub column: u32,
}

Available on crate feature serde only.

Enhanced source code location with const evaluation.

YoshiLocation captures the file name, line number, and column number where an error or context was created. This is crucial for debugging and pinpointing the exact origin of an issue in the source code.

Fields

file: &'static str

File path with const string optimization.

A static string slice representing the full path to the source file.

line: u32

Line number.

The line number in the source file.

column: u32

Column number.

The column number within the line in the source file.

Implementations

impl YoshiLocation

pub const fn new(file: &'static str, line: u32, column: u32) -> Self

Creates a new location with const evaluation where possible.

This constructor is typically used by the yoshi_location! macro to capture source locations at compile time.

Arguments

• file - The static string slice representing the file path.
• line - The line number.
• column - The column number.

Returns

A new YoshiLocation instance.

Examples

const MY_LOCATION: YoshiLocation = YoshiLocation::new("src/main.rs", 10, 5);
assert_eq!(MY_LOCATION.file, "src/main.rs");
assert_eq!(MY_LOCATION.line, 10);
assert_eq!(MY_LOCATION.column, 5);

pub fn filename(&self) -> &str

Gets just the filename without path for compact display.

This utility method extracts the base filename from the full file path, making it more convenient for display in logs or error messages.

Returns

A string slice containing only the filename.

Examples

let loc = YoshiLocation::new("/home/user/project/src/lib.rs", 1, 1);
assert_eq!(loc.filename(), "lib.rs");

let loc_windows = YoshiLocation::new("C:\\Users\\dev\\main.rs", 1, 1);
// On Windows, filename() should work with both path separators
assert!(loc_windows.filename().ends_with("main.rs"));

Trait Implementations

impl Clone for YoshiLocation

fn clone(&self) -> YoshiLocation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for YoshiLocation

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

Formats the value using the given formatter.

impl Deserialize<'static> for YoshiLocation

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

where __D: Deserializer<'static>,

Deserialize this value from the given Serde deserializer.

impl Display for YoshiLocation

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

Formats the YoshiLocation for display in file:line:column format.

Arguments

• f - The formatter to write into.

Returns

A fmt::Result indicating success or failure of the formatting.

Examples

let loc = YoshiLocation::new("src/utils.rs", 123, 45);
assert_eq!(format!("{}", loc), "utils.rs:123:45");

impl Hash for YoshiLocation

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 YoshiLocation

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for YoshiLocation

impl Eq for YoshiLocation

impl StructuralPartialEq for YoshiLocation