UniQuote

This crate allows quoting strings for use in output. It works similarly to [str::escape_debug], but the result is meant to be shown to users. Simply call [Quote::quote] on an argument passed to [println!] or a similar macro to quote it.

One of the primary uses for this crate is displaying paths losslessly. Since [Path] has no [Display] implementation, it is usually output by calling [Path::display] or [Path::to_string_lossy] beforehand. However, both of those methods are lossy; they replace all invalid characters with [REPLACEMENT_CHARACTER]. This crate escapes those invalid characters instead, allowing them to always be displayed correctly.

Usage

Add the following lines to your "Cargo.toml" file:

toml [dependencies] uniquote = "1.1"

See the [documentation] for available functionality and examples.

Rust version support

The minimum supported Rust toolchain version is currently Rust 1.37.0.

However, the "min_const_generics" feature requires a nightly compiler.

License

Licensing terms are specified in [COPYRIGHT].

Unless you explicitly state otherwise, any contribution submitted for inclusion in this crate, as defined in [LICENSE-APACHE], shall be licensed according to [COPYRIGHT], without any additional terms or conditions.