Struct MaybeStdin

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

Wrapper struct to parse arg values from stdin

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

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

#[derive(Debug, Parser)]
struct Args {
    path: MaybeStdin<PathBuf>,
}

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

$ pwd | ./example -
/current/working/dir

Implementations

impl<T> MaybeStdin<T>

pub fn is_stdin(&self) -> bool

Was this value read from stdin

impl<T> MaybeStdin<T>

pub fn into_inner(self) -> T

Extract the inner value from the wrapper

Trait Implementations

impl<T: Clone> Clone for MaybeStdin<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for MaybeStdin<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> Deref for MaybeStdin<T>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T> DerefMut for MaybeStdin<T>

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

Mutably dereferences the value.

impl<T> Display for MaybeStdin<T>

where T: Display,

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

Formats the value using the given formatter.

impl<T> FromStr for MaybeStdin<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.