mirror of
https://github.com/uutils/uutils.github.io.git
synced 2026-06-10 16:12:28 -07:00
32 lines
12 KiB
HTML
32 lines
12 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="An extension trait to apply quoting to strings."><title>Quotable in uucore::display - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Bold-a2c9cd1067f8b328.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-f3501f0f5ae15dfb.css" id="mainThemeStyle"><div id="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="uucore" data-themes="" data-resource-suffix="" data-rustdoc-version="1.71.1 (eb26296b5 2023-08-03)" data-search-js="search-4926e5fc22a5646a.js" data-settings-js="settings-de11bff964e9d4e5.js" data-settings-css="settings-8c76f75bfb6bd192.css" data-theme-light-css="light-0f8c037637f9eb3e.css" data-theme-dark-css="dark-1097f8e92a01e3cf.css" data-theme-ayu-css="ayu-614652228113ac93.css" ></div><script src="../../static.files/storage-62ce34ea385b278a.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-f0540c1d82cde29b.js"></script><noscript><link rel="stylesheet" media="(prefers-color-scheme:light)" href="../../static.files/light-0f8c037637f9eb3e.css"><link rel="stylesheet" media="(prefers-color-scheme:dark)" href="../../static.files/dark-1097f8e92a01e3cf.css"><link rel="stylesheet" href="../../static.files/noscript-13285aec31fa243e.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="logo-container" href="../../uucore/index.html"><img class="rust-logo" src="../../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><h2></h2></nav><nav class="sidebar"><a class="logo-container" href="../../uucore/index.html"><img class="rust-logo" src="../../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><h2 class="location"><a href="#">Quotable</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.quote">quote</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.maybe_quote">maybe_quote</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-Quotable-for-OsStr">OsStr</a></li><li><a href="#impl-Quotable-for-Path">Path</a></li><li><a href="#impl-Quotable-for-str">str</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In uucore::display</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Trait <a href="../index.html">uucore</a>::<wbr><a href="index.html">display</a>::<wbr><a class="trait" href="#">Quotable</a><button id="copy-path" title="Copy item path to clipboard"><img src="../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub trait Quotable {
|
||
// Required method
|
||
fn <a href="#tymethod.quote" class="fn">quote</a>(&self) -> <a class="struct" href="struct.Quoted.html" title="struct uucore::display::Quoted">Quoted</a><'_>;
|
||
|
||
// Provided method
|
||
fn <a href="#method.maybe_quote" class="fn">maybe_quote</a>(&self) -> <a class="struct" href="struct.Quoted.html" title="struct uucore::display::Quoted">Quoted</a><'_> { ... }
|
||
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>An extension trait to apply quoting to strings.</p>
|
||
<p>This is implemented on <a href="https://doc.rust-lang.org/1.71.1/std/primitive.str.html" title="primitive str"><code>str</code></a>, <a href="https://doc.rust-lang.org/1.71.1/std/ffi/os_str/struct.OsStr.html" title="struct std::ffi::os_str::OsStr"><code>OsStr</code></a> and <a href="https://doc.rust-lang.org/1.71.1/std/path/struct.Path.html" title="struct std::path::Path"><code>Path</code></a>.</p>
|
||
<p>For finer control, see the constructors on <a href="struct.Quoted.html" title="struct uucore::display::Quoted"><code>Quoted</code></a>.</p>
|
||
</div></details><h2 id="required-methods" class="small-section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.quote" class="method"><h4 class="code-header">fn <a href="#tymethod.quote" class="fn">quote</a>(&self) -> <a class="struct" href="struct.Quoted.html" title="struct uucore::display::Quoted">Quoted</a><'_></h4></section></summary><div class="docblock"><p>Returns an object that implements <a href="https://doc.rust-lang.org/1.71.1/core/fmt/trait.Display.html" title="trait core::fmt::Display"><code>Display</code></a> for printing strings with
|
||
proper quoting and escaping for the platform.</p>
|
||
<p>On Unix this corresponds to bash/ksh syntax, on Windows PowerShell syntax
|
||
is used.</p>
|
||
<h5 id="examples"><a href="#examples">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::path::Path;
|
||
<span class="kw">use </span>os_display::Quotable;
|
||
|
||
<span class="kw">let </span>path = Path::new(<span class="string">"foo/bar.baz"</span>);
|
||
|
||
<span class="macro">println!</span>(<span class="string">"Found file {}"</span>, path.quote()); <span class="comment">// Prints "Found file 'foo/bar.baz'"</span></code></pre></div>
|
||
</div></details></div><h2 id="provided-methods" class="small-section-header">Provided Methods<a href="#provided-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="method.maybe_quote" class="method"><h4 class="code-header">fn <a href="#method.maybe_quote" class="fn">maybe_quote</a>(&self) -> <a class="struct" href="struct.Quoted.html" title="struct uucore::display::Quoted">Quoted</a><'_></h4></section></summary><div class="docblock"><p>Like <code>quote()</code>, but don’t actually add quotes unless necessary because of
|
||
whitespace or special characters.</p>
|
||
<h5 id="examples-1"><a href="#examples-1">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::path::Path;
|
||
<span class="kw">use </span>os_display::Quotable;
|
||
|
||
<span class="kw">let </span>foo = Path::new(<span class="string">"foo/bar.baz"</span>);
|
||
<span class="kw">let </span>bar = <span class="string">"foo bar"</span>;
|
||
|
||
<span class="macro">println!</span>(<span class="string">"{}: Not found"</span>, foo.maybe_quote()); <span class="comment">// Prints "foo/bar.baz: Not found"
|
||
</span><span class="macro">println!</span>(<span class="string">"{}: Not found"</span>, bar.maybe_quote()); <span class="comment">// Prints "'foo bar': Not found"</span></code></pre></div>
|
||
</div></details></div><h2 id="foreign-impls" class="small-section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><details class="toggle implementors-toggle"><summary><section id="impl-Quotable-for-OsStr" class="impl"><a href="#impl-Quotable-for-OsStr" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Quotable.html" title="trait uucore::display::Quotable">Quotable</a> for <a class="struct" href="https://doc.rust-lang.org/1.71.1/std/ffi/os_str/struct.OsStr.html" title="struct std::ffi::os_str::OsStr">OsStr</a></h3></section></summary><div class="impl-items"><section id="method.quote" class="method trait-impl"><a href="#method.quote" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.quote" class="fn">quote</a>(&self) -> <a class="struct" href="struct.Quoted.html" title="struct uucore::display::Quoted">Quoted</a><'_></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Quotable-for-str" class="impl"><a href="#impl-Quotable-for-str" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Quotable.html" title="trait uucore::display::Quotable">Quotable</a> for <a class="primitive" href="https://doc.rust-lang.org/1.71.1/std/primitive.str.html">str</a></h3></section></summary><div class="impl-items"><section id="method.quote-1" class="method trait-impl"><a href="#method.quote-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.quote" class="fn">quote</a>(&self) -> <a class="struct" href="struct.Quoted.html" title="struct uucore::display::Quoted">Quoted</a><'_></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Quotable-for-Path" class="impl"><a href="#impl-Quotable-for-Path" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Quotable.html" title="trait uucore::display::Quotable">Quotable</a> for <a class="struct" href="https://doc.rust-lang.org/1.71.1/std/path/struct.Path.html" title="struct std::path::Path">Path</a></h3></section></summary><div class="impl-items"><section id="method.quote-2" class="method trait-impl"><a href="#method.quote-2" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.quote" class="fn">quote</a>(&self) -> <a class="struct" href="struct.Quoted.html" title="struct uucore::display::Quoted">Quoted</a><'_></h4></section></div></details><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../../implementors/os_display/native/trait.Quotable.js" data-ignore-extern-crates="std" async></script></section></div></main></body></html> |