Trait normpath::PathExt

pub trait PathExt: Sealed {
    // Required methods
    fn normalize(&self) -> Result<BasePathBuf>;
    fn normalize_virtually(&self) -> Result<BasePathBuf>;
}

Additional methods added to Path.

Required Methods

fn normalize(&self) -> Result<BasePathBuf>

Normalizes self relative to the current directory.

This method will access the file system to normalize the path. If the path might not exist, normalize_virtually can be used instead, but it is only available on Windows. Other platforms require file system access to perform normalization.

Unix Behavior

On Unix, normalization is equivalent to canonicalization.

Windows Behavior

On Windows, normalization is similar to canonicalization, but:

• the prefix of the path is rarely changed. Canonicalization would always return a verbatim path, which can be difficult to use. (rust-lang/rust#42869)
• the result is more consistent. (rust-lang/rust#49342)
• shared partition paths do not cause an error. (rust-lang/rust#52440)

However, verbatim paths will not be modified, so they might still contain . or .. components. BasePath::join and BasePathBuf::push can normalize them before they become part of the path.

Implementation

Currently, this method calls:

• fs::canonicalize on Unix.
• GetFullPathNameW on Windows.

However, the implementation is subject to change. This section is only informative.

Errors

Returns an error if self cannot be normalized or does not exist, even on Windows.

This method is designed to give mostly consistent errors on different platforms, even when the functions it calls have different behavior. To normalize paths that might not exist, use normalize_virtually.

Examples

use std::path::Path;

use normpath::PathExt;

if cfg!(windows) {
    assert_eq!(
        Path::new(r"X:\foo\baz\test.rs"),
        Path::new("X:/foo/bar/../baz/test.rs").normalize()?,
    );
}

fn normalize_virtually(&self) -> Result<BasePathBuf>

Equivalent to normalize but does not access the file system.

Errors

Returns an error if self cannot be normalized or contains a null byte. Nonexistent paths will not cause an error.

Examples

use std::path::Path;

use normpath::PathExt;

#[cfg(windows)]
assert_eq!(
    Path::new(r"X:\foo\baz\test.rs"),
    Path::new("X:/foo/bar/../baz/test.rs").normalize_virtually()?,
);

Implementations on Foreign Types

impl PathExt for Path

fn normalize(&self) -> Result<BasePathBuf>

fn normalize_virtually(&self) -> Result<BasePathBuf>

Implementors