Struct shell_quote::Fish

pub struct Fish;

Quote byte strings for use with fish.

⚠️ Warning

Prior to version 3.6.2, fish did not correctly handle some Unicode code points encoded as UTF-8. From the version 3.6.2 release notes:

fish uses certain Unicode non-characters internally for marking wildcards and expansions. It incorrectly allowed these markers to be read on command substitution output, rather than transforming them into a safe internal representation.

At present this crate has no workaround for this issue. Please use fish 3.6.2 or later.

Notes

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_vec<'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_vec for a variant that extends an existing Vec instead of allocating a new one.

Examples

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

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

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

See quote_vec for more details.

Examples

let mut buf = Vec::with_capacity(128);
Fish::quote_into_vec("foobar", &mut buf);
buf.push(b' ');  // Add a space.
Fish::quote_into_vec("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 QuoteInto<BString> for Fish

fn quote_into<'q, S: ?Sized + Into<Quotable<'q>>>(s: S, out: &mut BString)

Quote/escape a string of bytes into an existing container.

impl QuoteInto<String> for Fish

fn quote_into<'q, S: ?Sized + Into<Quotable<'q>>>(s: S, out: &mut String)

Quote/escape a string of bytes into an existing container.

impl QuoteInto<Vec<u8>> for Fish

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

Quote/escape a string of bytes into an existing container.

impl Copy for Fish