Struct clap_stdin::FileOrStdin

pub struct FileOrStdin<T = String> {
    pub source: Source,
    /* private fields */
}

Wrapper struct to either read in a file or contents from stdin

FileOrStdin can wrap any type that matches the trait bounds for Arg: FromStr and Clone

use std::path::PathBuf;
use clap::Parser;
use clap_stdin::FileOrStdin;

#[derive(Debug, Parser)]
struct Args {
    contents: FileOrStdin,
}

if let Ok(args) = Args::try_parse() {
    println!("contents={}", args.contents);
}

$ cat <filename> | ./example -
<filename> contents

$ ./example <filename>
<filename> contents

Fields

source: Source

Source of the contents

Implementations

impl<T> FileOrStdin<T>

pub fn into_inner(self) -> T

Extract the inner value from the wrapper

Trait Implementations

impl<T: Clone> Clone for FileOrStdin<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for FileOrStdin<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> Deref for FileOrStdin<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for FileOrStdin

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T> Display for FileOrStdin<T>

where T: Display,

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

Formats the value using the given formatter.

impl<T> FromStr for FileOrStdin<T>

where T: FromStr, <T as FromStr>::Err: Display,

type Err = StdinError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.