1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81
#![forbid(unsafe_code)]
#![warn(clippy::all)]
#![allow(clippy::needless_doctest_main)]
//! clio is a library for parsing CLI file names.
//!
//! It implemts the standard unix convetions of when the file name is "-" then sending the
//! data to stdin/stdout as apropriate
//!
//! # Usage
//! [`Input`](crate::Input)s and [`Output`](crate::Input)s can be created directly from the args
//! The will error if the file cannot be opened for any reason
//! ```
//! // a cat replacement
//! fn main() -> clio::Result<()> {
//! for arg in std::env::args_os() {
//! let mut input = clio::Input::new(&arg)?;
//! std::io::copy(&mut input, &mut std::io::stdout())?;
//! }
//! Ok(())
//! }
//! ```
//!
//! They are also desgined to be used with [structopt](https://docs.rs/structopt)/[clap](https://docs.rs/clap)
//! ```
//! use clap::Parser;
//! use clio::*;
//!
//! #[derive(Parser)]
//! #[clap(name = "cat")]
//! struct Opt {
//! /// Input file, use '-' for stdin
//! #[clap(parse(try_from_os_str = TryFrom::try_from), default_value="-")]
//! input: Input,
//!
//! /// Output file '-' for stdout
//! #[clap(long, short, parse(try_from_os_str = TryFrom::try_from), default_value="-")]
//! output: Output,
//! }
//!
//! fn main() {
//! let mut opt = Opt::parse();
//!
//! std::io::copy(&mut opt.input, &mut opt.output).unwrap();
//! }
//! ```
//!
//! # Features
//! ### `http`
//! bundles in [ureq](https://docs.rs/ureq) as a HTTP client.
//!
//! If a url is passed to [`Input::new`](crate::Input::new) then it will perform and HTTP `GET`.
//!
//! If a url is passed to [`Output::new`](crate::Output::new) then it will perform and HTTP `PUT`.
//! You can use [`SizedOutput`](crate::SizedOutput) to set the size before the upload starts e.g.
//! needed if you are sending a file to S3.
mod error;
#[cfg(feature = "http")]
mod http;
mod input;
mod output;
pub use crate::error::Error;
pub use crate::error::Result;
pub use crate::input::CachedInput;
pub use crate::input::Input;
pub use crate::output::Output;
pub use crate::output::SizedOutput;
use std::fs::File;
#[cfg(not(unix))]
fn is_fifo(file: &File) -> Result<bool> {
Ok(false)
}
#[cfg(unix)]
fn is_fifo(file: &File) -> Result<bool> {
use std::os::unix::fs::FileTypeExt;
Ok(file.metadata()?.file_type().is_fifo())
}