Enum clio::SizedOutput

pub enum SizedOutput {
    Stdout(Stdout),
    Pipe(OsString, File),
    File(OsString, File),
}

A builder for Output that allows setting the size before writing. This is mostly usefull with the “http” feature for setting the Content-Length header

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::SizedOutput;

#[derive(Parser)]
struct Opt {
    /// path to file, use '-' for stdout
    #[clap(value_parser)]
    output_file: SizedOutput,
}

Variants

Stdout(Stdout)

a Stdout when the path was -

Pipe(OsString, File)

a File represeinting the named pipe e.g. crated with mkfifo

File(OsString, File)

a normal File opened from the path

Implementations

impl SizedOutput

pub fn new<S: AsRef<OsStr>>(path: S) -> Result<Self>

Contructs a new output either by opening/creating the file or for ‘-’ returning stdout

pub fn std() -> Self

Contructs a new output to stdout

pub fn try_from_os_str(path: &OsStr) -> Result<Self, OsString>

Contructs a new SizedOutput either by opening/creating the file or for ‘-’ returning stdout

The error is converted to a OsString so that stuctopt can show it to the user.

It is recomended that you use TryFrom::try_from and clap 3.0 instead.

pub fn with_len(self, size: u64) -> Result<Output>

set the length of the file, either using File::set_len or as the content-length header of the http put

pub fn without_len(self) -> Result<Output>

convert to an normal Output without setting the length

pub fn maybe_with_len(self, size: Option<u64>) -> Result<Output>

convert to an normal Output setting the length of the file to size if it is Some

pub fn path(&self) -> &OsStr

The original path used to create this SizedOutput

Trait Implementations

impl Debug for SizedOutput

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

Formats the value using the given formatter.

impl Default for SizedOutput

fn default() -> Self

Returns the “default value” for a type.

impl Display for SizedOutput

formats as the path it was created from

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

Formats the value using the given formatter.

impl TryFrom<&'_ OsStr> for SizedOutput

type Error = Error

The type returned in the event of a conversion error.

fn try_from(file_name: &OsStr) -> Result<Self>

Performs the conversion.