57 lines
14 KiB
HTML
57 lines
14 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 `str` mod in crate `nom`."><meta name="keywords" content="rust, rustlang, rust-lang, str"><title>nom::lib::std::str - 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 str</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</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: 'str', 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#159' 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=''>str</a></span></h1><div class='docblock'><p>Unicode string slices.</p>
|
||
<p><em><a href="../../std/primitive.str.html">See also the <code>str</code> primitive type</a>.</em></p>
|
||
<p>The <code>&str</code> type is one of the two main string types, the other being <code>String</code>.
|
||
Unlike its <code>String</code> counterpart, its contents are borrowed.</p>
|
||
<h1 id="basic-usage" class="section-header"><a href="#basic-usage">Basic Usage</a></h1>
|
||
<p>A basic string declaration of <code>&str</code> type:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="ident">hello_world</span> <span class="op">=</span> <span class="string">"Hello, World!"</span>;</pre></div>
|
||
<p>Here we have declared a string literal, also known as a string slice.
|
||
String literals have a static lifetime, which means the string <code>hello_world</code>
|
||
is guaranteed to be valid for the duration of the entire program.
|
||
We can explicitly specify <code>hello_world</code>'s lifetime as well:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="ident">hello_world</span>: <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span> <span class="op">=</span> <span class="string">"Hello, world!"</span>;</pre></div>
|
||
</div><h2 id='modules' class='section-header'><a href="#modules">Modules</a></h2>
|
||
<table><tr class='unstable module-item'><td><a class="mod" href="pattern/index.html" title='nom::lib::std::str::pattern mod'>pattern</a></td><td class='docblock-short'><span class="stab unstable">Experimental</span><p>The string Pattern API.</p>
|
||
</td></tr></table><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
||
<table><tr class='module-item'><td><a class="struct" href="struct.Bytes.html" title='nom::lib::std::str::Bytes struct'>Bytes</a></td><td class='docblock-short'><p>An iterator over the bytes of a string slice.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.CharIndices.html" title='nom::lib::std::str::CharIndices struct'>CharIndices</a></td><td class='docblock-short'><p>An iterator over the <a href="../../std/primitive.char.html"><code>char</code></a>s of a string slice, and their positions.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Chars.html" title='nom::lib::std::str::Chars struct'>Chars</a></td><td class='docblock-short'><p>An iterator over the <a href="../../std/primitive.char.html"><code>char</code></a>s of a string slice.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.EncodeUtf16.html" title='nom::lib::std::str::EncodeUtf16 struct'>EncodeUtf16</a></td><td class='docblock-short'><p>An iterator of <a href="../../std/primitive.u16.html"><code>u16</code></a> over the string encoded as UTF-16.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.EscapeDebug.html" title='nom::lib::std::str::EscapeDebug struct'>EscapeDebug</a></td><td class='docblock-short'><p>The return type of <a href="../../std/primitive.str.html#method.escape_debug"><code>str::escape_debug</code></a>.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.EscapeDefault.html" title='nom::lib::std::str::EscapeDefault struct'>EscapeDefault</a></td><td class='docblock-short'><p>The return type of <a href="../../std/primitive.str.html#method.escape_default"><code>str::escape_default</code></a>.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.EscapeUnicode.html" title='nom::lib::std::str::EscapeUnicode struct'>EscapeUnicode</a></td><td class='docblock-short'><p>The return type of <a href="../../std/primitive.str.html#method.escape_unicode"><code>str::escape_unicode</code></a>.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Lines.html" title='nom::lib::std::str::Lines struct'>Lines</a></td><td class='docblock-short'><p>An iterator over the lines of a string, as string slices.</p>
|
||
</td></tr><tr class='deprecated module-item'><td><a class="struct" href="struct.LinesAny.html" title='nom::lib::std::str::LinesAny struct'>LinesAny</a></td><td class='docblock-short'><span class="stab deprecated">Deprecated</span><p>Created with the method <a href="../../std/primitive.str.html#method.lines_any"><code>lines_any</code></a>.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.MatchIndices.html" title='nom::lib::std::str::MatchIndices struct'>MatchIndices</a></td><td class='docblock-short'><p>Created with the method <a href="../../std/primitive.str.html#method.match_indices"><code>match_indices</code></a>.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Matches.html" title='nom::lib::std::str::Matches struct'>Matches</a></td><td class='docblock-short'><p>Created with the method <a href="../../std/primitive.str.html#method.matches"><code>matches</code></a>.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.ParseBoolError.html" title='nom::lib::std::str::ParseBoolError struct'>ParseBoolError</a></td><td class='docblock-short'><p>An error returned when parsing a <code>bool</code> using <a href="../../std/primitive.bool.html#method.from_str"><code>from_str</code></a> fails</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.RMatchIndices.html" title='nom::lib::std::str::RMatchIndices struct'>RMatchIndices</a></td><td class='docblock-short'><p>Created with the method <a href="../../std/primitive.str.html#method.rmatch_indices"><code>rmatch_indices</code></a>.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.RMatches.html" title='nom::lib::std::str::RMatches struct'>RMatches</a></td><td class='docblock-short'><p>Created with the method <a href="../../std/primitive.str.html#method.rmatches"><code>rmatches</code></a>.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.RSplit.html" title='nom::lib::std::str::RSplit struct'>RSplit</a></td><td class='docblock-short'><p>Created with the method <a href="../../std/primitive.str.html#method.rsplit"><code>rsplit</code></a>.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.RSplitN.html" title='nom::lib::std::str::RSplitN struct'>RSplitN</a></td><td class='docblock-short'><p>Created with the method <a href="../../std/primitive.str.html#method.rsplitn"><code>rsplitn</code></a>.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.RSplitTerminator.html" title='nom::lib::std::str::RSplitTerminator struct'>RSplitTerminator</a></td><td class='docblock-short'><p>Created with the method <a href="../../std/primitive.str.html#method.rsplit_terminator"><code>rsplit_terminator</code></a>.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Split.html" title='nom::lib::std::str::Split struct'>Split</a></td><td class='docblock-short'><p>Created with the method <a href="../../std/primitive.str.html#method.split"><code>split</code></a>.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.SplitAsciiWhitespace.html" title='nom::lib::std::str::SplitAsciiWhitespace struct'>SplitAsciiWhitespace</a></td><td class='docblock-short'><p>An iterator over the non-ASCII-whitespace substrings of a string,
|
||
separated by any amount of ASCII whitespace.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.SplitN.html" title='nom::lib::std::str::SplitN struct'>SplitN</a></td><td class='docblock-short'><p>Created with the method <a href="../../std/primitive.str.html#method.splitn"><code>splitn</code></a>.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.SplitTerminator.html" title='nom::lib::std::str::SplitTerminator struct'>SplitTerminator</a></td><td class='docblock-short'><p>Created with the method <a href="../../std/primitive.str.html#method.split_terminator"><code>split_terminator</code></a>.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.SplitWhitespace.html" title='nom::lib::std::str::SplitWhitespace struct'>SplitWhitespace</a></td><td class='docblock-short'><p>An iterator over the non-whitespace substrings of a string,
|
||
separated by any amount of whitespace.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Utf8Error.html" title='nom::lib::std::str::Utf8Error struct'>Utf8Error</a></td><td class='docblock-short'><p>Errors which can occur when attempting to interpret a sequence of <a href="../../std/primitive.u8.html"><code>u8</code></a>
|
||
as a 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.FromStr.html" title='nom::lib::std::str::FromStr trait'>FromStr</a></td><td class='docblock-short'><p>Parse a value from a string</p>
|
||
</td></tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
|
||
<table><tr class='module-item'><td><a class="fn" href="fn.from_boxed_utf8_unchecked.html" title='nom::lib::std::str::from_boxed_utf8_unchecked fn'>from_boxed_utf8_unchecked</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td><td class='docblock-short'><p>Converts a boxed slice of bytes to a boxed string slice without checking
|
||
that the string contains valid UTF-8.</p>
|
||
</td></tr><tr class='module-item'><td><a class="fn" href="fn.from_utf8.html" title='nom::lib::std::str::from_utf8 fn'>from_utf8</a></td><td class='docblock-short'><p>Converts a slice of bytes to a string slice.</p>
|
||
</td></tr><tr class='module-item'><td><a class="fn" href="fn.from_utf8_mut.html" title='nom::lib::std::str::from_utf8_mut fn'>from_utf8_mut</a></td><td class='docblock-short'><p>Converts a mutable slice of bytes to a mutable string slice.</p>
|
||
</td></tr><tr class='module-item'><td><a class="fn" href="fn.from_utf8_unchecked.html" title='nom::lib::std::str::from_utf8_unchecked fn'>from_utf8_unchecked</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td><td class='docblock-short'><p>Converts a slice of bytes to a string slice without checking
|
||
that the string contains valid UTF-8.</p>
|
||
</td></tr><tr class='module-item'><td><a class="fn" href="fn.from_utf8_unchecked_mut.html" title='nom::lib::std::str::from_utf8_unchecked_mut fn'>from_utf8_unchecked_mut</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td><td class='docblock-short'><p>Converts a slice of bytes to a string slice without checking
|
||
that the string contains valid UTF-8; mutable version.</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> |