Struct FileType 

pub struct FileType {
    pub mode: FileMode,
    pub lazy: Option<bool>,
    pub atomic: bool,
}

A parameter type for files.

Unlike PathType, this opens the file and returns a handle. The special value “-” indicates stdin (for reading) or stdout (for writing).

Fields

mode: FileMode

The mode to open the file in.

lazy: Option<bool>

Whether to open the file lazily.

atomic: bool

Whether to use atomic writes.

Implementations

impl FileType

pub const fn new() -> Self

Create a new file type for reading.

pub const fn mode(self, mode: FileMode) -> Self

Set the file mode.

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

Set whether to open lazily.

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

Set whether to use atomic writes.

Trait Implementations

impl Clone for FileType

fn clone(&self) -> FileType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileType

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

Formats the value using the given formatter.

impl Default for FileType

fn default() -> Self

Returns the “default value” for a type.

impl TypeConverter for FileType

type Value = LazyFile

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.