Struct SourcePath 

pub struct SourcePath(/* private fields */);

A normalised, relative, /-separated path to a source file, used as the primary key for files everywhere in sealmap.

Normalisation makes keys identical on every platform:

use sealmap_model::SourcePath;

let a = SourcePath::new("src/./net/../lib.rs").unwrap();
let b = SourcePath::new("src\\lib.rs").unwrap();
assert_eq!(a, b);
assert_eq!(a.as_str(), "src/lib.rs");

assert!(SourcePath::new("/etc/passwd").is_err());
assert!(SourcePath::new("../outside.rs").is_err());

Implementations

impl SourcePath

pub fn new(raw: impl AsRef<str>) -> Result<Self, PathError>

Normalise raw into a SourcePath.

Backslashes are treated as separators, . components are dropped and .. components are resolved lexically. Absolute paths and paths that escape the root are rejected.

pub fn relative_to(path: &Path, root: &Path) -> Result<Self, PathError>

Make path relative to root and normalise it.

Non-UTF-8 components are converted lossily.

pub fn as_str(&self) -> &str

The normalised path string.

pub fn file_name(&self) -> &str

The final component, e.g. lib.rs.

pub fn extension(&self) -> Option<&str>

The extension without the dot, if any.

pub fn components(&self) -> impl Iterator<Item = &str>

Path components in order.

pub fn with_suffix(&self, suffix: &str) -> Self

Append a suffix to the whole path (src/lib.rs + .mmd → src/lib.rs.mmd). This is how the corpus maps sources 1:1 to diagrams.

Trait Implementations

impl Clone for SourcePath

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SourcePath

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SourcePath

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SourcePath

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

Formats the value using the given formatter.

impl Eq for SourcePath

impl From<SourcePath> for String

fn from(value: SourcePath) -> Self

Converts to this type from the input type.

impl Hash for SourcePath

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 Ord for SourcePath

fn cmp(&self, other: &Self) -> 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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for SourcePath

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for SourcePath

fn partial_cmp(&self, other: &Self) -> 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 Serialize for SourcePath

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SourcePath

impl TryFrom<String> for SourcePath

type Error = PathError

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self, Self::Error>

Performs the conversion.