Skip to main content

ExpandOptions

Struct ExpandOptions 

Source
pub struct ExpandOptions {
    pub expand_tilde: bool,
    pub expand_percent_variables: bool,
    pub expand_dollar_variables: bool,
    pub translate_wsl_paths: bool,
    pub reject_undefined_variables: bool,
    pub trim_cli_input: bool,
    pub max_expansion_depth: u32,
}
Expand description

Options controlling how user path input is expanded.

§Defaults

  • Expand ~ at the start of the path
  • Expand %VAR% and $VAR / ${VAR}
  • Reject undefined variables
  • Trim surrounding whitespace
  • Do not translate WSL /mnt/<drive>/... paths

Fields§

§expand_tilde: bool

Expand a leading ~ or ~/ / ~\ to the home directory.

§expand_percent_variables: bool

Expand %VAR% style variables (generic; works on any platform if set).

§expand_dollar_variables: bool

Expand $VAR and ${VAR} style variables.

§translate_wsl_paths: bool

Translate /mnt/<drive>/... to a Windows path when applicable.

§reject_undefined_variables: bool

When true, undefined variables produce an error; when false, they are left unchanged.

§trim_cli_input: bool

Trim leading and trailing whitespace from the input.

§max_expansion_depth: u32

Maximum nested expansion passes (defensive limit).

Implementations§

Source§

impl ExpandOptions

Source

pub fn new() -> Self

Create default options (Self::default()).

Source

pub fn none() -> Self

Create options with all expansion disabled.

Trait Implementations§

Source§

impl Clone for ExpandOptions

Source§

fn clone(&self) -> ExpandOptions

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ExpandOptions

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ExpandOptions

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for ExpandOptions

Source§

impl PartialEq for ExpandOptions

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for ExpandOptions

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.