Struct Argument 

pub struct Argument(/* private fields */);

One argument of an external command

An argument holds what the program receives, as the caller wrote it. Nothing splits it at a space, removes a quotation mark, or expands a character such as *, because no shell reads the command. An argument that holds a space is one argument, and not two.

The value is an OsString, because a program takes the strings of the operating system and not the strings of Rust. An argument can therefore carry a path that is not valid UTF-8, which a file system allows.

Examples

use kawauso_process::invocation::Argument;

let argument = Argument::from("--message=two words");

assert_eq!(argument.get(), "--message=two words");

Implementations

impl Argument

pub fn new(argument: impl Into<OsString>) -> Self

Creates an argument from anything that becomes an OsString

Examples

use kawauso_process::invocation::Argument;

let argument = Argument::new("--short");

assert_eq!(argument.get(), "--short");

pub fn get(&self) -> &OsStr

Returns the argument as the caller wrote it

Trait Implementations

impl Clone for Argument

fn clone(&self) -> Argument

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Argument

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

Formats the value using the given formatter.

impl Display for Argument

Shows the argument for a reader

An argument that is not valid UTF-8 shows the replacement character U+FFFD for each byte that has no character. The text is for a person, and no caller reads it back into an argument.

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

Formats the value using the given formatter.

impl Eq for Argument

impl From<&OsStr> for Argument

Creates an argument from a borrowed string of the operating system

fn from(argument: &OsStr) -> Self

Converts to this type from the input type.

impl From<&Path> for Argument

Creates an argument from a borrowed path, such as the root of a project

fn from(argument: &Path) -> Self

Converts to this type from the input type.

impl From<&str> for Argument

Creates an argument from a borrowed string, such as a literal

fn from(argument: &str) -> Self

Converts to this type from the input type.

impl From<OsString> for Argument

Creates an argument from a string of the operating system

fn from(argument: OsString) -> Self

Converts to this type from the input type.

impl From<PathBuf> for Argument

Creates an argument from a path that the application built at runtime

fn from(argument: PathBuf) -> Self

Converts to this type from the input type.

impl From<String> for Argument

Creates an argument from a string that the application built at runtime

fn from(argument: String) -> Self

Converts to this type from the input type.

impl Hash for Argument

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Argument

fn cmp(&self, other: &Argument) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Argument

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Argument

fn partial_cmp(&self, other: &Argument) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for Argument