Enum Input

pub enum Input {
    Path(PathBuf),
    Stdin,
}

An input source for reading.

Variants

Path(PathBuf)

A path from which to read a file.

Stdin

Stdin.

Implementations

impl Input

pub const ENV_KEY_DISABLE_CHECK: &'static str = "SFS_ALLOW_STDIN"

By default, reading an Input checks that either a path is provided, or that input is available via stdin, instead of hanging.

In some contexts, e.g. testing, this can cause issues, and so it may be disabled by setting this environment variable, or by using Input::new_unchecked.

pub fn new(input: Option<PathBuf>) -> Result<Self>

Creates a new input source.

pub fn new_unchecked(input: Option<PathBuf>) -> Self

Creates a new input source without checking that any data is available.

pub fn open(&self) -> Result<Reader>

Open the input for reading.

pub fn as_path(&self) -> Option<&Path>

Returns the provided path if provided, otherwise None.

Trait Implementations

impl Debug for Input

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

Formats the value using the given formatter.

impl From<Input> for Option<PathBuf>

fn from(input: Input) -> Self

Converts to this type from the input type.