Struct clio::InputPath

pub struct InputPath { /* private fields */ }

A builder for Input that validates the path but defers creating it until you call the create 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: AsRef<OsStr>>(path: S) -> Result<Self>

Contructs 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

Contructs a new InputPath to stdout (“-”)

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

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

pub fn path(&self) -> &OsStr

The original path used to create this InputPath

Trait Implementations

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<InputPath> for InputPath

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

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 Eq for InputPath

impl StructuralEq for InputPath

impl StructuralPartialEq for InputPath