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.

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: AsRef<OsStr>>(path: S) -> Result<Self>

Construct a new OutputPath from an string

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

pub fn std() -> Self

Contructs a new OutputPath of "-" for stdout

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

Creater 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) -> &OsStr

The original path represented by this OutputPath

Trait Implementations

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<OutputPath> 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: &OutputPath) -> bool

This method tests for !=.

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 Eq for OutputPath

impl StructuralEq for OutputPath

impl StructuralPartialEq for OutputPath