Struct Quoted 

pub struct Quoted<'a> { /* private fields */ }

A wrapper around string types for displaying with quoting and escaping applied.

Implementations

impl<'a> Quoted<'a>

pub fn native(text: &'a str) -> Self

Quote a string with the default style for the platform.

On Windows this is PowerShell syntax, on all other platforms this is bash/ksh syntax.

pub fn native_raw(text: &'a OsStr) -> Self

Quote an OsStr with the default style for the platform.

On platforms other than Windows and Unix, if the encoding is invalid, the Debug representation will be used.

pub fn unix(text: &'a str) -> Self

Quote a string using bash/ksh syntax.

Optional

This requires the optional unix feature.

pub fn unix_raw(bytes: &'a [u8]) -> Self

Quote possibly invalid UTF-8 using bash/ksh syntax.

Optional

This requires the optional unix feature.

pub fn windows(text: &'a str) -> Self

Quote a string using PowerShell syntax.

Optional

This requires the optional windows feature.

Examples found in repository

examples/echo.rs (line 15)

fn main() {
    for arg in std::env::args_os().skip(1) {
        println!("Native: {}", arg.maybe_quote());
        #[cfg(all(windows, feature = "unix"))]
        {
            if let Some(arg) = arg.to_str() {
                println!("Unix: {}", os_display::Quoted::unix(arg).force(false));
            }
        }
        #[cfg(all(not(windows), feature = "windows"))]
        {
            if let Some(arg) = arg.to_str() {
                println!("Windows: {}", os_display::Quoted::windows(arg).force(false));
            }
        }
    }
}

pub fn windows_raw(units: &'a [u16]) -> Self

Quote possibly invalid UTF-16 using PowerShell syntax.

Optional

This requires the optional windows feature and the (default) alloc feature.

pub fn force(self, force: bool) -> Self

Toggle forced quoting. If true, quotes are added even if no special characters are present.

Defaults to true.

Examples found in repository

examples/echo.rs (line 15)

fn main() {
    for arg in std::env::args_os().skip(1) {
        println!("Native: {}", arg.maybe_quote());
        #[cfg(all(windows, feature = "unix"))]
        {
            if let Some(arg) = arg.to_str() {
                println!("Unix: {}", os_display::Quoted::unix(arg).force(false));
            }
        }
        #[cfg(all(not(windows), feature = "windows"))]
        {
            if let Some(arg) = arg.to_str() {
                println!("Windows: {}", os_display::Quoted::windows(arg).force(false));
            }
        }
    }
}

pub fn external(self, external: bool) -> Self

When quoting for PowerShell, toggle whether to use legacy quoting for external programs.

If enabled, double quotes (and sometimes backslashes) will be escaped so that they can be passed to external programs in PowerShell versions before 7.3, or with $PSNativeCommandArgumentPassing set to 'Legacy'.

If disabled, quoting will suit modern argument passing (always used for internal commandlets and .NET functions). Strings that look like options or numbers will be quoted.

It is sadly impossible to quote a string such that it’s suitable for both modern and legacy argument passing.

Defaults to false.

Optional

This requires either the windows or the native feature. It has no effect on Unix-style quoting.

Trait Implementations

impl<'a> Clone for Quoted<'a>

fn clone(&self) -> Quoted<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Quoted<'a>

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

Formats the value using the given formatter.

impl Display for Quoted<'_>

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

Formats the value using the given formatter.

impl<'a, T: Quotable + ?Sized> From<&'a T> for Quoted<'a>

fn from(val: &'a T) -> Self

Converts to this type from the input type.

impl<'a> Copy for Quoted<'a>