oxipng/doc/bitflags/__core/str/index.html
2016-04-20 15:59:23 -04:00

302 lines
No EOL
16 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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 `bitflags`.">
<meta name="keywords" content="rust, rustlang, rust-lang, str">
<title>bitflags::__core::str - Rust</title>
<link rel="stylesheet" type="text/css" href="../../../rustdoc.css">
<link rel="stylesheet" type="text/css" href="../../../main.css">
</head>
<body class="rustdoc">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
<p class='location'><a href='../../index.html'>bitflags</a>::<wbr><a href='../index.html'>__core</a></p><script>window.sidebarCurrent = {name: 'str', ty: 'mod', relpath: '../'};</script><script defer src="../sidebar-items.js"></script>
</nav>
<nav class="sub">
<form class="search-form js-only">
<div class="search-container">
<input class="search-input" name="search"
autocomplete="off"
placeholder="Click or press S to search, ? for more options…"
type="search">
</div>
</form>
</nav>
<section id='main' class="content mod">
<h1 class='fqn'><span class='in-band'>Module <a href='../../index.html'>bitflags</a>::<wbr><a href='../index.html'>__core</a>::<wbr><a class='mod' href=''>str</a></span><span class='out-of-band'><span id='render-detail'>
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
[<span class='inner'>&#x2212;</span>]
</a>
</span><a id='src-3172' class='srclink' href='https://doc.rust-lang.org/nightly/collections/str/index.html?gotosrc=3172' title='goto source code'>[src]</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>
</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='bitflags::__core::str::pattern'>pattern</a></td>
<td class='docblock short'>
[<em class='stab unstable'>Unstable</em>] <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='bitflags::__core::str::Bytes'>Bytes</a></td>
<td class='docblock short'>
<p>External iterator for a string&#39;s bytes.
Use with the <code>std::iter</code> module.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class='struct' href='struct.CharIndices.html'
title='bitflags::__core::str::CharIndices'>CharIndices</a></td>
<td class='docblock short'>
<p>Iterator for a string&#39;s characters and their byte offsets.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class='struct' href='struct.Chars.html'
title='bitflags::__core::str::Chars'>Chars</a></td>
<td class='docblock short'>
<p>Iterator for the char (representing <em>Unicode Scalar Values</em>) of a string</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class='struct' href='struct.EncodeUtf16.html'
title='bitflags::__core::str::EncodeUtf16'>EncodeUtf16</a></td>
<td class='docblock short'>
<p>External iterator for a string&#39;s UTF-16 code units.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class='struct' href='struct.Lines.html'
title='bitflags::__core::str::Lines'>Lines</a></td>
<td class='docblock short'>
<p>Created with the method <a href="../../std/primitive.str.html#method.lines"><code>lines()</code></a>.</p>
</td>
</tr>
<tr class=' deprecated module-item'>
<td><a class='struct' href='struct.LinesAny.html'
title='bitflags::__core::str::LinesAny'>LinesAny</a></td>
<td class='docblock short'>
[<em class='stab deprecated'>Deprecated</em>] <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='bitflags::__core::str::MatchIndices'>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='bitflags::__core::str::Matches'>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='bitflags::__core::str::ParseBoolError'>ParseBoolError</a></td>
<td class='docblock short'>
<p>An error returned when parsing a <code>bool</code> from a string fails.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class='struct' href='struct.RMatchIndices.html'
title='bitflags::__core::str::RMatchIndices'>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='bitflags::__core::str::RMatches'>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='bitflags::__core::str::RSplit'>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='bitflags::__core::str::RSplitN'>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='bitflags::__core::str::RSplitTerminator'>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='bitflags::__core::str::Split'>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.SplitN.html'
title='bitflags::__core::str::SplitN'>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='bitflags::__core::str::SplitTerminator'>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='bitflags::__core::str::SplitWhitespace'>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='bitflags::__core::str::Utf8Error'>Utf8Error</a></td>
<td class='docblock short'>
<p>Errors which can occur when attempting to interpret a sequence of <code>u8</code>
as a string.</p>
</td>
</tr>
<tr class='unstable module-item'>
<td><a class='struct' href='struct.CharRange.html'
title='bitflags::__core::str::CharRange'>CharRange</a></td>
<td class='docblock short'>
[<em class='stab unstable'>Unstable</em>] <p>Struct that contains a <code>char</code> and the index of the first byte of
the next <code>char</code> in a string. This can be used as a data structure
for iterating over the UTF-8 bytes of 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='bitflags::__core::str::FromStr'>FromStr</a></td>
<td class='docblock short'>
<p>A trait to abstract the idea of creating a new instance of a type 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_utf8.html'
title='bitflags::__core::str::from_utf8'>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_unchecked.html'
title='bitflags::__core::str::from_utf8_unchecked'>from_utf8_unchecked</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></table><h2 id='types' class='section-header'><a href="#types">Type Definitions</a></h2>
<table>
<tr class='unstable deprecated module-item'>
<td><a class='type' href='type.Utf16Units.html'
title='bitflags::__core::str::Utf16Units'>Utf16Units</a></td>
<td class='docblock short'>
[<em class='stab unstable deprecated'>Deprecated</em>]
</td>
</tr></table></section>
<section id='search' class="content hidden"></section>
<section class="footer"></section>
<aside id="help" class="hidden">
<div>
<h1 class="hidden">Help</h1>
<div class="shortcuts">
<h2>Keyboard Shortcuts</h2>
<dl>
<dt>?</dt>
<dd>Show this help dialog</dd>
<dt>S</dt>
<dd>Focus the search field</dd>
<dt>&larrb;</dt>
<dd>Move up in search results</dd>
<dt>&rarrb;</dt>
<dd>Move down in search results</dd>
<dt>&#9166;</dt>
<dd>Go to active search result</dd>
</dl>
</div>
<div class="infos">
<h2>Search Tricks</h2>
<p>
Prefix searches with a type followed by a colon (e.g.
<code>fn:</code>) to restrict the search to a given type.
</p>
<p>
Accepted types are: <code>fn</code>, <code>mod</code>,
<code>struct</code>, <code>enum</code>,
<code>trait</code>, <code>type</code>, <code>macro</code>,
and <code>const</code>.
</p>
<p>
Search functions by type signature (e.g.
<code>vec -> usize</code> or <code>* -> vec</code>)
</p>
</div>
</div>
</aside>
<script>
window.rootPath = "../../../";
window.currentCrate = "bitflags";
window.playgroundUrl = "";
</script>
<script src="../../../jquery.js"></script>
<script src="../../../main.js"></script>
<script defer src="../../../search-index.js"></script>
</body>
</html>