Struct SourceLocation

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

The location of source code at a point in the codebase.

This should generally be constructed by using the [current_location] macro.

Example

Basic Use:

#[doc(hidden)]
pub fn _inner_log(message: &str, location: astd::SourceLocation) {
  println!("{}: {}", location, message)
}

macro_rules! log {
  ($($arg:tt)*) => {
    _inner_log($($arg)*, astd::current_location!())
  };
}

// ...

// Implicitly captures source-location at the same time
log!("logging something with source location...");

Fields

file: &'static str

The path to the file

line: u32

The line within the file

column: u32

The column

Trait Implementations

impl Debug for SourceLocation

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

Formats the value using the given formatter.

impl Default for SourceLocation

fn default() -> SourceLocation

Returns the “default value” for a type.

impl Display for SourceLocation

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

Formats the value using the given formatter.

impl Ord for SourceLocation

fn cmp(&self, other: &SourceLocation) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for SourceLocation

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

fn partial_cmp(&self, other: &SourceLocation) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for SourceLocation

impl StructuralPartialEq for SourceLocation