Struct clio::clapers::OsStrParser

pub struct OsStrParser<T> { /* private fields */ }

A clap parser that converts &OsStr to an Input or Output

Implementations

impl<T> OsStrParser<T>

pub fn exists(self) -> Self

This path must exist

pub fn is_dir(self) -> Self

If this path exists it must point to a directory

pub fn is_file(self) -> Self

If this path exists it must point to a file

pub fn not_tty(self) -> Self

If this path is for stdin/stdout they must be a pipe not a tty

pub fn atomic(self) -> Self

Make writing atomic, by writing to a temp file then doing an atomic swap

pub fn default_name(self, name: &'static str) -> Self

The default name to use for the file if the path is a directory

Trait Implementations

impl<T: Clone> Clone for OsStrParser<T>

fn clone(&self) -> OsStrParser<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for OsStrParser<T>

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

Formats the value using the given formatter.

impl TypedValueParser for OsStrParser<ClioPath>

type Value = ClioPath

Argument’s value type

fn parse_ref( &self, cmd: &Command, arg: Option<&Arg>, value: &OsStr ) -> Result<Self::Value, Error>

Parse the argument value

fn parse( &self, cmd: &Command, arg: Option<&Arg>, value: OsString ) -> Result<Self::Value, Error>

Parse the argument value

fn possible_values( &self ) -> Option<Box<dyn Iterator<Item = PossibleValue> + '_>>

Reflect on enumerated value properties

fn map<T, F>(self, func: F) -> MapValueParser<Self, F>

where T: Send + Sync + Clone, F: Fn(Self::Value) -> T + Clone,

Adapt a TypedValueParser from one value to another

fn try_map<T, E, F>(self, func: F) -> TryMapValueParser<Self, F>

where F: Fn(Self::Value) -> Result<T, E> + Clone + Send + Sync + 'static, T: Send + Sync + Clone, E: Into<Box<dyn Error + Send + Sync>>,

Adapt a TypedValueParser from one value to another

impl<T> TypedValueParser for OsStrParser<T>

where for<'a> T: TryFrom<ClioPath, Error = Error> + Clone + Sync + Send + 'static,

type Value = T

Argument’s value type

fn parse_ref( &self, cmd: &Command, arg: Option<&Arg>, value: &OsStr ) -> Result<Self::Value, Error>

Parse the argument value

fn parse( &self, cmd: &Command, arg: Option<&Arg>, value: OsString ) -> Result<Self::Value, Error>

Parse the argument value

fn possible_values( &self ) -> Option<Box<dyn Iterator<Item = PossibleValue> + '_>>

Reflect on enumerated value properties

fn map<T, F>(self, func: F) -> MapValueParser<Self, F>

where T: Send + Sync + Clone, F: Fn(Self::Value) -> T + Clone,

Adapt a TypedValueParser from one value to another

fn try_map<T, E, F>(self, func: F) -> TryMapValueParser<Self, F>

where F: Fn(Self::Value) -> Result<T, E> + Clone + Send + Sync + 'static, T: Send + Sync + Clone, E: Into<Box<dyn Error + Send + Sync>>,

Adapt a TypedValueParser from one value to another

impl<T: Copy> Copy for OsStrParser<T>