Struct clio::OutputPath

pub struct OutputPath { /* private fields */ }

A builder for Output that validates the path but defers creating it until you call the create method.

The create_with_len allows setting the size before writing. This is mostly useful 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::OutputPath;

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

Implementations

impl OutputPath

pub fn new<S: TryInto<ClioPath>>(path: S) -> Result<Self>

where Error: From<<S as TryInto<ClioPath>>::Error>,

Construct a new OutputPath from an string

It checks if an output file could plausibly be created at that path

pub fn std() -> Self

Constructs a new OutputPath of "-" for stdout

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 create_with_len(self, size: u64) -> Result<Output>

Create the file with a predetermined length, either using File::set_len or as the content-length header of the http put

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

Create an Output without setting the length

pub fn path(&self) -> &ClioPath

The original path represented by this OutputPath

pub fn is_std(&self) -> bool

Returns true if this Output is stdout

pub fn is_tty(&self) -> bool

Returns true if this is stdout and it is connected to a tty

pub fn is_local(&self) -> bool

Returns true if this Output is on the local file system, as opposed to point to stout or a URL

pub fn can_seek(&self) -> bool

Returns true if this OutputPath points to a file, and false if this OutputPath is std out or points to a pipe. Note that the file is not opened yet, so there are possible when you open the file it might have changed.

Trait Implementations

impl Clone for OutputPath

fn clone(&self) -> OutputPath

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OutputPath

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

Formats the value using the given formatter.

impl Default for OutputPath

fn default() -> Self

Returns the “default value” for a type.

impl Display for OutputPath

formats as the path it was created from

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

Formats the value using the given formatter.

impl PartialEq for OutputPath

fn eq(&self, other: &OutputPath) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<&OsStr> for OutputPath

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&OsString> for OutputPath

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&Path> for OutputPath

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&PathBuf> for OutputPath

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&String> for OutputPath

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&str> for OutputPath

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<ClioPath> for OutputPath

type Error = Error

The type returned in the event of a conversion error.

fn try_from(file_name: ClioPath) -> Result<Self>

Performs the conversion.

impl ValueParserFactory for OutputPath

Available on crate feature clap-parse only.

type Parser = OsStrParser<OutputPath>

Generated parser, usually [ValueParser].

fn value_parser() -> Self::Parser

Create the specified [Self::Parser]

impl Eq for OutputPath

impl StructuralEq for OutputPath

impl StructuralPartialEq for OutputPath