25 lines
11 KiB
HTML
25 lines
11 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="API documentation for the Rust `ToString` trait in crate `nom`."><meta name="keywords" content="rust, rustlang, rust-lang, ToString"><title>nom::lib::std::string::ToString - Rust</title><link rel="stylesheet" type="text/css" href="../../../../normalize.css"><link rel="stylesheet" type="text/css" href="../../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../../../dark.css"><link rel="stylesheet" type="text/css" href="../../../../light.css" id="themeStyle"><script src="../../../../storage.js"></script><noscript><link rel="stylesheet" href="../../../../noscript.css"></noscript><link rel="shortcut icon" href="../../../../favicon.ico"><style type="text/css">#crate-search{background-image:url("../../../../down-arrow.svg");}</style></head><body class="rustdoc trait"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../../../nom/index.html'><div class='logo-container'><img src='../../../../rust-logo.png' alt='logo'></div></a><p class='location'>Trait ToString</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.to_string">to_string</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-ToString-for-Cow%3C%27_%2C%20str%3E">Cow<'_, str></a><a href="#impl-ToString-for-str">str</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='../../../index.html'>nom</a>::<wbr><a href='../../index.html'>lib</a>::<wbr><a href='../index.html'>std</a>::<wbr><a href='index.html'>string</a></p><script>window.sidebarCurrent = {name: 'ToString', ty: 'trait', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../../../../settings.html"><img src="../../../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span class='since' title='Stable since Rust version 1.0.0'>1.0.0</span><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='https://doc.rust-lang.org/nightly/src/alloc/string.rs.html#2135-2151' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='../../../index.html'>nom</a>::<wbr><a href='../../index.html'>lib</a>::<wbr><a href='../index.html'>std</a>::<wbr><a href='index.html'>string</a>::<wbr><a class="trait" href=''>ToString</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub trait ToString {
|
||
fn <a href='#tymethod.to_string' class='fnname'>to_string</a>(&self) -> <a class="struct" href="../../../../nom/lib/std/prelude/v1/v1/struct.String.html" title="struct nom::lib::std::prelude::v1::v1::String">String</a>;
|
||
}</pre></div><div class='docblock'><p>A trait for converting a value to a <code>String</code>.</p>
|
||
<p>This trait is automatically implemented for any type which implements the
|
||
<a href="../../std/fmt/trait.Display.html"><code>Display</code></a> trait. As such, <code>ToString</code> shouldn't be implemented directly:
|
||
<a href="../../std/fmt/trait.Display.html"><code>Display</code></a> should be implemented instead, and you get the <code>ToString</code>
|
||
implementation for free.</p>
|
||
</div>
|
||
<h2 id='required-methods' class='small-section-header'>Required methods<a href='#required-methods' class='anchor'></a></h2><div class='methods'><h3 id='tymethod.to_string' class='method'><code id='to_string.v'>fn <a href='#tymethod.to_string' class='fnname'>to_string</a>(&self) -> <a class="struct" href="../../../../nom/lib/std/prelude/v1/v1/struct.String.html" title="struct nom::lib::std::prelude::v1::v1::String">String</a></code></h3><div class='docblock'><p>Converts the given value to a <code>String</code>.</p>
|
||
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
|
||
<p>Basic usage:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="ident">i</span> <span class="op">=</span> <span class="number">5</span>;
|
||
<span class="kw">let</span> <span class="ident">five</span> <span class="op">=</span> <span class="ident">String</span>::<span class="ident">from</span>(<span class="string">"5"</span>);
|
||
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">five</span>, <span class="ident">i</span>.<span class="ident">to_string</span>());</pre></div>
|
||
</div></div><span class='loading-content'>Loading content...</span>
|
||
<h2 id='foreign-impls' class='small-section-header'>Implementations on Foreign Types<a href='#foreign-impls' class='anchor'></a></h2><h3 id='impl-ToString-for-Cow%3C%27_%2C%20str%3E' class='impl'><code class='in-band'>impl<'_> <a class="trait" href="../../../../nom/lib/std/prelude/v1/v1/trait.ToString.html" title="trait nom::lib::std::prelude::v1::v1::ToString">ToString</a> for <a class="enum" href="https://doc.rust-lang.org/nightly/alloc/borrow/enum.Cow.html" title="enum alloc::borrow::Cow">Cow</a><'_, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>></code><a href='#impl-ToString-for-Cow%3C%27_%2C%20str%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/alloc/string.rs.html#2181-2186' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.to_string' class="method hidden"><code id='to_string.v-1'>fn <a href='#method.to_string' class='fnname'>to_string</a>(&self) -> <a class="struct" href="../../../../nom/lib/std/prelude/v1/v1/struct.String.html" title="struct nom::lib::std::prelude::v1::v1::String">String</a></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/alloc/string.rs.html#2183-2185' title='goto source code'>[src]</a></h4></div><h3 id='impl-ToString-for-str' class='impl'><code class='in-band'>impl <a class="trait" href="../../../../nom/lib/std/prelude/v1/v1/trait.ToString.html" title="trait nom::lib::std::prelude::v1::v1::ToString">ToString</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a></code><a href='#impl-ToString-for-str' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/alloc/string.rs.html#2173-2178' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.to_string-1' class="method hidden"><code id='to_string.v-2'>fn <a href='#method.to_string' class='fnname'>to_string</a>(&self) -> <a class="struct" href="../../../../nom/lib/std/prelude/v1/v1/struct.String.html" title="struct nom::lib::std::prelude::v1::v1::String">String</a></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/alloc/string.rs.html#2175-2177' title='goto source code'>[src]</a></h4></div><span class='loading-content'>Loading content...</span>
|
||
<h2 id='implementors' class='small-section-header'>Implementors<a href='#implementors' class='anchor'></a></h2><div class='item-list' id='implementors-list'><h3 id='impl-ToString' class='impl'><code class='in-band'>impl ToString for <a class="struct" href="../../../../nom/lib/std/prelude/v1/v1/struct.String.html" title="struct nom::lib::std::prelude::v1::v1::String">String</a></code><a href='#impl-ToString' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/alloc/string.rs.html#2189-2194' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.to_string-2' class="method hidden"><code id='to_string.v-3'>fn <a href='#method.to_string-2' class='fnname'>to_string</a>(&self) -> <a class="struct" href="../../../../nom/lib/std/prelude/v1/v1/struct.String.html" title="struct nom::lib::std::prelude::v1::v1::String">String</a></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/alloc/string.rs.html#2191-2193' title='goto source code'>[src]</a></h4></div><h3 id='impl-ToString-1' class='impl'><code class='in-band'>impl<T> ToString for T <span class="where fmt-newline">where<br> T: <a class="trait" href="../../../../nom/lib/std/fmt/trait.Display.html" title="trait nom::lib::std::fmt::Display">Display</a> + ?<a class="trait" href="../../../../nom/lib/std/prelude/v1/v1/trait.Sized.html" title="trait nom::lib::std::prelude::v1::v1::Sized">Sized</a>, </span></code><a href='#impl-ToString-1' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/alloc/string.rs.html#2160-2170' title='goto source code'>[src]</a></h3><div class='docblock'><h1 id="panics" class="section-header"><a href="#panics">Panics</a></h1>
|
||
<p>In this implementation, the <code>to_string</code> method panics
|
||
if the <code>Display</code> implementation returns an error.
|
||
This indicates an incorrect <code>Display</code> implementation
|
||
since <code>fmt::Write for String</code> never returns an error itself.</p>
|
||
</div><div class='impl-items'><h4 id='method.to_string-3' class="method hidden"><code id='to_string.v-4'>default fn <a href='#method.to_string-3' class='fnname'>to_string</a>(&self) -> <a class="struct" href="../../../../nom/lib/std/prelude/v1/v1/struct.String.html" title="struct nom::lib::std::prelude::v1::v1::String">String</a></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/alloc/string.rs.html#2162-2169' title='goto source code'>[src]</a></h4></div></div><span class='loading-content'>Loading content...</span><script type="text/javascript" src="../../../../implementors/alloc/string/trait.ToString.js" async></script></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../../../../";window.currentCrate = "nom";</script><script src="../../../../aliases.js"></script><script src="../../../../main.js"></script><script defer src="../../../../search-index.js"></script></body></html> |