Struct PathInputOptions 

pub struct PathInputOptions<'a> {
    pub home_dir: Option<&'a Path>,
    /* private fields */
}

Options controlling path normalization.

Mirrors TypeScript PathInputOptions. PathInputOptions::new and Default both default expand_tilde to true.

Fields

home_dir: Option<&'a Path>

Home directory used for ~ expansion. When None and expansion is enabled, the process home directory is used.

Implementations

impl<'a> PathInputOptions<'a>

pub const fn new() -> Self

Defaults matching TypeScript normalizePath option defaults.

pub const fn trim(self, trim: bool) -> Self

Set whether leading/trailing whitespace is trimmed.

pub const fn trims_input(self) -> bool

Return whether leading/trailing whitespace is trimmed.

pub const fn expand_tilde(self, expand_tilde: bool) -> Self

Set whether a leading ~ is expanded.

pub const fn expands_tilde(self) -> bool

Return whether a leading ~ is expanded.

pub const fn home_dir(self, home_dir: Option<&'a Path>) -> Self

Set the home directory used for ~ expansion.

pub const fn strip_at_prefix(self, strip_at_prefix: bool) -> Self

Set whether a leading @ is stripped.

pub const fn strips_at_prefix(self) -> bool

Return whether a leading @ is stripped.

pub const fn normalize_unicode_spaces( self, normalize_unicode_spaces: bool, ) -> Self

Set whether Unicode space variants are normalized.

pub const fn normalizes_unicode_spaces(self) -> bool

Return whether Unicode space variants are normalized.

Trait Implementations

impl<'a> Clone for PathInputOptions<'a>

fn clone(&self) -> PathInputOptions<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for PathInputOptions<'a>

impl<'a> Debug for PathInputOptions<'a>

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

Formats the value using the given formatter.

impl Default for PathInputOptions<'_>

fn default() -> Self

Returns the “default value” for a type.