Struct shell_quote::Fish

pub struct Fish;

Quote byte strings for use with fish.

The documentation on quoting and escaping characters in fish is confusing at first, especially when coming from a Bourne-like shell, but essentially we have to be able to move and and out of a quoted string context. For example, the escape sequence \t for a tab must be outside of quotes, single or double, to be recognised as a tab character by fish:

echo 'foo'\t'bar'

This emphasises the importance of using the correct quoting module for the target shell.

Implementations

impl Fish

pub fn quote<'a, S: ?Sized + Into<Quotable<'a>>>(s: S) -> Vec<u8>

Quote a string of bytes into a new Vec<u8>.

This will return one of the following:

• The string as-is, if no escaping is necessary.
• An escaped string, like 'foo \'bar', \a'ABC'

See quote_into for a variant that extends an existing Vec instead of allocating a new one.

Examples

assert_eq!(Fish::quote("foobar"), b"foobar");
assert_eq!(Fish::quote("foo 'bar"), b"'foo \\'bar'");

pub fn quote_into<'a, S: ?Sized + Into<Quotable<'a>>>(s: S, sout: &mut Vec<u8>)

Quote a string of bytes into an existing Vec<u8>.

See quote for more details.

Examples

let mut buf = Vec::with_capacity(128);
Fish::quote_into("foobar", &mut buf);
buf.push(b' ');  // Add a space.
Fish::quote_into("foo 'bar", &mut buf);
assert_eq!(buf, b"foobar 'foo \\'bar'");

Trait Implementations

impl Clone for Fish

fn clone(&self) -> Fish

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Fish

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

Formats the value using the given formatter.

impl Copy for Fish

impl Quoter for Fish