Struct uucore::display::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) -> Quoted<'a>

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) -> Quoted<'a>

Quote an OsStr with the default style for the platform.

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

pub fn force(self, force: bool) -> Quoted<'a>

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

Defaults to true.

pub fn external(self, external: bool) -> Quoted<'a>

When quoting for PowerShell, toggle whether to quote for external programs.

If enabled, double quotes (and sometimes backslashes) will be escaped so that they can be passed to external programs.

If disabled, quoting will suit 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 external and internal commands.

The experimental PSNativeCommandArgumentPassing feature in PowerShell 7.2 disables the stripping of double quotes and backslashes. If it’s enabled then this setting should be disabled.

Defaults to false. This could change in a future (breaking) release.

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 copy 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<(), Error>

Formats the value using the given formatter.

impl<'a> Display for Quoted<'a>

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

Formats the value using the given formatter.

impl<'a, T> From<&'a T> for Quoted<'a>

where T: Quotable + ?Sized,

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

Converts to this type from the input type.

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