Struct PathType 

pub struct PathType {
    pub exists: bool,
    pub file_okay: bool,
    pub dir_okay: bool,
    pub readable: bool,
    pub writable: bool,
    pub executable: bool,
    pub resolve_path: bool,
    pub allow_dash: bool,
}

A parameter type for file system paths with optional validation.

Unlike the File type, this returns the path as a PathBuf rather than opening the file.

Fields

exists: bool

Whether the path must exist.

file_okay: bool

Whether files are allowed.

dir_okay: bool

Whether directories are allowed.

readable: bool

Whether the path must be readable.

writable: bool

Whether the path must be writable.

executable: bool

Whether the path must be executable.

resolve_path: bool

Whether to resolve the path to an absolute path.

allow_dash: bool

Whether to allow “-” to indicate stdin/stdout.

Implementations

impl PathType

pub const fn new() -> Self

Create a new path type with default settings.

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

Require the path to exist.

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

Allow only files (not directories).

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

Allow only directories (not files).

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

Require the path to be readable.

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

Require the path to be writable.

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

Require the path to be executable.

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

Resolve the path to an absolute path.

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

Allow “-” to indicate stdin/stdout.

Trait Implementations

impl Clone for PathType

fn clone(&self) -> PathType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PathType

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

Formats the value using the given formatter.

impl Default for PathType

fn default() -> Self

Returns the “default value” for a type.

impl TypeConverter for PathType

type Value = PathBuf

The Rust type that this parameter type converts to.

fn name(&self) -> &str

Returns the descriptive name of this type (used in error messages).

fn convert(&self, value: &str) -> Result<Self::Value, String>

Convert a string value to the target type.

fn split_envvar_value(&self, value: &str) -> Vec<String>

Split an environment variable value into multiple values.

fn shell_complete(&self, incomplete: &str) -> Vec<CompletionItem>

Returns shell completion items for the given incomplete value.

fn get_metavar(&self) -> Option<String>

Returns the metavar for this type (used in help text).

fn get_missing_message(&self) -> Option<String>

Returns an optional message when a required value is missing.

fn is_composite(&self) -> bool

Whether this type is a composite type (like Tuple).

fn arity(&self) -> usize

The arity (number of values consumed) for composite types.