Struct Quoter

pub struct Quoter { /* private fields */ }

A more configurable interface to quote strings. If you only want the default settings you can use the convenience functions try_quote and try_join.

The bytes equivalent is bytes::Quoter.

Implementations

impl Quoter

pub fn new() -> Self

Create a new Quoter with default settings.

pub fn allow_nul(self, allow: bool) -> Self

Set whether to allow nul bytes. By default they are not allowed and will result in an error of QuoteError::Nul.

pub fn join<'a, I: IntoIterator<Item = &'a str>>( &self, words: I, ) -> Result<String, QuoteError>

Convenience function that consumes an iterable of words and turns it into a single string, quoting words when necessary. Consecutive words will be separated by a single space.

pub fn quote<'a>(&self, in_str: &'a str) -> Result<Cow<'a, str>, QuoteError>

Given a single word, return a string suitable to encode it as a shell argument.

Trait Implementations

impl Clone for Quoter

fn clone(&self) -> Quoter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Quoter

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

Formats the value using the given formatter.

impl Default for Quoter

fn default() -> Quoter

Returns the “default value” for a type.

impl From<Quoter> for Quoter

fn from(inner: Quoter) -> Quoter

Converts to this type from the input type.

impl From<Quoter> for Quoter

fn from(quoter: Quoter) -> Quoter

Converts to this type from the input type.