Struct ShellQuote 

pub struct ShellQuote { /* private fields */ }

Available on crate feature shell only.

𝕃 𝐓 Quotes shell words for command strings.

---

^{📍 lang/prog/script/shell}

---

Implementations

impl ShellQuote

pub const fn new() -> Self

Creates a shell word quoter.

pub const fn reject_control(self, reject: bool) -> Self

Rejects interactive-unsafe control bytes.

pub const fn quoted_len(self, word: &[u8]) -> Result<usize, ShellWordError>

Returns the number of bytes required to quote word.

Errors

Returns ShellWordError::Nul if word contains a nul byte. Returns ShellWordError::Control if control bytes are rejected.

pub const fn quote_to( self, word: &[u8], out: &mut [u8], ) -> Result<usize, ShellWordError>

Writes word as one shell word into out.

Returns the number of bytes written.

Errors

Returns ShellWordError::OutputTooSmall if out is too small. Also returns the validation errors from quoted_len.

Trait Implementations

impl Clone for ShellQuote

fn clone(&self) -> ShellQuote

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ShellQuote

impl Debug for ShellQuote

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

Formats the value using the given formatter.

impl Default for ShellQuote

fn default() -> ShellQuote

Returns the “default value” for a type.

impl Eq for ShellQuote

impl Hash for ShellQuote

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 PartialEq for ShellQuote

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for ShellQuote