Struct SystemPath 

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

An OS path kimün has made usable on this machine: absolute and normalized (no . or .. components left).

Normalization is not cosmetic. A canonicalized Windows path is the verbatim form \\?\C:\…, and Win32 reads every component of a verbatim path literally — \\?\C:\kimun\. names a file called ., which no create_dir_all and no SQLite open can use. Comparing two Paths hides it (PartialEq goes through Components, which drops .), so only the real filesystem call notices, on one platform, at runtime.

The invariant lives in the type because the alternative was tried: a PathBuf that callers were told to resolve first, with a silent fallback when they didn’t.

Implementations

impl SystemPath

pub fn try_absolute<P: AsRef<Path>>(path: P) -> Result<Self, SystemError>

Accepts an already-absolute path, normalizing it.

Rejects a relative path rather than resolving it against the process’s working directory: that would make the result depend on where the binary was launched, which is the failure this type exists to prevent. Callers holding a relative path want SystemPath::resolve, which makes them name the base.

pub fn resolve<P: AsRef<Path>>(path: P, base: &SystemPath) -> Self

Resolves a path that may be relative, may start with ~, and may not exist yet, against base.

~ expands to the home directory (left as-is when there is none), relative paths resolve against base, ./.. are removed, and the result is canonicalized when it already exists on disk — the canonical form is what later starts_with comparisons and the index’s stored paths must agree with.

pub fn canonical<P: AsRef<Path>>(path: P) -> Result<Self, SystemError>

Resolves an existing path to its canonical form — symlinks followed, ./.. gone, absolute.

Fails when the path does not exist: canonicalization is the OS answering “what is this really”, and there is no answer for something that is not there. Callers resolving a path that may not exist yet want SystemPath::resolve.

pub fn join<S: AsRef<Path>>(&self, segment: S) -> Self

This path with segment appended, staying normalized (so a .. segment cancels rather than accumulating).

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

This path with suffix appended to its file name — index.db plus -wal is index.db-wal, not index.db/-wal and not index-wal.db. How SQLite names the files beside a database.

pub fn parent(&self) -> Option<Self>

The containing directory, or None at the root.

pub fn as_path(&self) -> &Path

Borrows the underlying OS path, for the standard library and for callers that take AsRef<Path>.

pub fn into_path_buf(self) -> PathBuf

Consumes this path, yielding the PathBuf.

pub fn exists(&self) -> bool

Whether something exists at this path.

pub fn is_dir(&self) -> bool

Whether this path names an existing directory.

Trait Implementations

impl AsRef<Path> for SystemPath

fn as_ref(&self) -> &Path

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for SystemPath

fn clone(&self) -> SystemPath

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SystemPath

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

Formats the value using the given formatter.

impl Display for SystemPath

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

Formats the value using the given formatter.

impl Eq for SystemPath

impl Hash for SystemPath

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 SystemPath

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for SystemPath

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