43 lines
8.3 KiB
HTML
43 lines
8.3 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 `string` mod in crate `nom`."><meta name="keywords" content="rust, rustlang, rust-lang, string"><title>nom::lib::std::string - 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 mod"><!--[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'>Module string</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li><li><a href="#types">Type Definitions</a></li></ul></div><p class='location'><a href='../../../index.html'>nom</a>::<wbr><a href='../../index.html'>lib</a>::<wbr><a href='../index.html'>std</a></p><script>window.sidebarCurrent = {name: 'string', ty: 'mod', 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/lib.rs.html#160' title='goto source code'>[src]</a></span><span class='in-band'>Module <a href='../../../index.html'>nom</a>::<wbr><a href='../../index.html'>lib</a>::<wbr><a href='../index.html'>std</a>::<wbr><a class="mod" href=''>string</a></span></h1><div class='docblock'><p>A UTF-8 encoded, growable string.</p>
|
||
<p>This module contains the <a href="struct.String.html"><code>String</code></a> type, a trait for converting
|
||
<a href="trait.ToString.html"><code>ToString</code></a>s, and several error types that may result from working with
|
||
<a href="struct.String.html"><code>String</code></a>s.</p>
|
||
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
|
||
<p>There are multiple ways to create a new <a href="struct.String.html"><code>String</code></a> from a string literal:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="ident">s</span> <span class="op">=</span> <span class="string">"Hello"</span>.<span class="ident">to_string</span>();
|
||
|
||
<span class="kw">let</span> <span class="ident">s</span> <span class="op">=</span> <span class="ident">String</span>::<span class="ident">from</span>(<span class="string">"world"</span>);
|
||
<span class="kw">let</span> <span class="ident">s</span>: <span class="ident">String</span> <span class="op">=</span> <span class="string">"also this"</span>.<span class="ident">into</span>();</pre></div>
|
||
<p>You can create a new <a href="struct.String.html"><code>String</code></a> from an existing one by concatenating with
|
||
<code>+</code>:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="ident">s</span> <span class="op">=</span> <span class="string">"Hello"</span>.<span class="ident">to_string</span>();
|
||
|
||
<span class="kw">let</span> <span class="ident">message</span> <span class="op">=</span> <span class="ident">s</span> <span class="op">+</span> <span class="string">" world!"</span>;</pre></div>
|
||
<p>If you have a vector of valid UTF-8 bytes, you can make a <a href="struct.String.html"><code>String</code></a> out of
|
||
it. You can do the reverse too.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="ident">sparkle_heart</span> <span class="op">=</span> <span class="macro">vec</span><span class="macro">!</span>[<span class="number">240</span>, <span class="number">159</span>, <span class="number">146</span>, <span class="number">150</span>];
|
||
|
||
<span class="comment">// We know these bytes are valid, so we'll use `unwrap()`.</span>
|
||
<span class="kw">let</span> <span class="ident">sparkle_heart</span> <span class="op">=</span> <span class="ident">String</span>::<span class="ident">from_utf8</span>(<span class="ident">sparkle_heart</span>).<span class="ident">unwrap</span>();
|
||
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="string">"💖"</span>, <span class="ident">sparkle_heart</span>);
|
||
|
||
<span class="kw">let</span> <span class="ident">bytes</span> <span class="op">=</span> <span class="ident">sparkle_heart</span>.<span class="ident">into_bytes</span>();
|
||
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">bytes</span>, [<span class="number">240</span>, <span class="number">159</span>, <span class="number">146</span>, <span class="number">150</span>]);</pre></div>
|
||
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
||
<table><tr class='module-item'><td><a class="struct" href="struct.Drain.html" title='nom::lib::std::string::Drain struct'>Drain</a></td><td class='docblock-short'><p>A draining iterator for <code>String</code>.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.FromUtf8Error.html" title='nom::lib::std::string::FromUtf8Error struct'>FromUtf8Error</a></td><td class='docblock-short'><p>A possible error value when converting a <code>String</code> from a UTF-8 byte vector.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.FromUtf16Error.html" title='nom::lib::std::string::FromUtf16Error struct'>FromUtf16Error</a></td><td class='docblock-short'><p>A possible error value when converting a <code>String</code> from a UTF-16 byte slice.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.String.html" title='nom::lib::std::string::String struct'>String</a></td><td class='docblock-short'><p>A UTF-8 encoded, growable string.</p>
|
||
</td></tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
|
||
<table><tr class='module-item'><td><a class="trait" href="trait.ToString.html" title='nom::lib::std::string::ToString trait'>ToString</a></td><td class='docblock-short'><p>A trait for converting a value to a <code>String</code>.</p>
|
||
</td></tr></table><h2 id='types' class='section-header'><a href="#types">Type Definitions</a></h2>
|
||
<table><tr class='module-item'><td><a class="type" href="type.ParseError.html" title='nom::lib::std::string::ParseError type'>ParseError</a></td><td class='docblock-short'><p>A type alias for <a href="../../core/convert/enum.Infallible.html"><code>Infallible</code></a>.</p>
|
||
</td></tr></table></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> |