Struct InputPath

pub struct InputPath { /* private fields */ }

A builder for Input that validates the path but defers creating it until you call the open method.

It is designed to be used with the clap crate when taking a file name as an argument to CLI app

use clap::Parser;
use clio::InputPath;

#[derive(Parser)]
struct Opt {
    /// path to file, use '-' for stdin
    #[clap(value_parser)]
    input_file: InputPath,
}

Implementations

impl InputPath

pub fn new<S: TryInto<ClioPath>>(path: S) -> Result<Self>

where Error: From<<S as TryInto<ClioPath>>::Error>,

Constructs a new InputPath representing the path and checking that the file exists and is readable

note: even if this passes open may still fail if e.g. the file was delete in between

pub fn std() -> Self

Constructs a new InputPath to stdout (“-”)

pub fn is_std(&self) -> bool

Returns true if this InputPath is stdin

pub fn is_tty(&self) -> bool

Returns true if this is stdin and it is connected to a tty

pub fn is_local(&self) -> bool

Returns true if this InputPath is on the local file system, as opposed to point to stdin or a URL

pub fn open(self) -> Result<Input>

Create an Input by opening the file or for ‘-’ returning stdin.

This is unlikely to error as the path is checked when the InputPath was created by new but time of use/time of check means that things could have changed in-between e.g. the file could have been deleted.

pub fn path(&self) -> &ClioPath

The original path used to create this InputPath

Trait Implementations

impl Clone for InputPath

fn clone(&self) -> InputPath

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InputPath

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

Formats the value using the given formatter.

impl Default for InputPath

fn default() -> Self

Returns the “default value” for a type.

impl Display for InputPath

formats as the path it was created from

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

Formats the value using the given formatter.

impl PartialEq for InputPath

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<&OsStr> for InputPath

type Error = Error

The type returned in the event of a conversion error.

fn try_from(file_name: &OsStr) -> Result<Self>

Performs the conversion.

impl TryFrom<&OsString> for InputPath

type Error = Error

The type returned in the event of a conversion error.

fn try_from(file_name: &OsString) -> Result<Self>

Performs the conversion.

impl TryFrom<&Path> for InputPath

type Error = Error

The type returned in the event of a conversion error.

fn try_from(file_name: &Path) -> Result<Self>

Performs the conversion.

impl TryFrom<&PathBuf> for InputPath

type Error = Error

The type returned in the event of a conversion error.

fn try_from(file_name: &PathBuf) -> Result<Self>

Performs the conversion.

impl TryFrom<&String> for InputPath

type Error = Error

The type returned in the event of a conversion error.

fn try_from(file_name: &String) -> Result<Self>

Performs the conversion.

impl TryFrom<&str> for InputPath

type Error = Error

The type returned in the event of a conversion error.

fn try_from(file_name: &str) -> Result<Self>

Performs the conversion.

impl TryFrom<ClioPath> for InputPath

type Error = Error

The type returned in the event of a conversion error.

fn try_from(file_name: ClioPath) -> Result<Self>

Performs the conversion.

impl ValueParserFactory for InputPath

Available on crate feature clap-parse only.

type Parser = OsStrParser<InputPath>

Generated parser, usually ValueParser.

fn value_parser() -> Self::Parser

Create the specified Self::Parser

impl Eq for InputPath

impl StructuralPartialEq for InputPath