18 lines
4.9 KiB
HTML
18 lines
4.9 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` crate."><meta name="keywords" content="rust, rustlang, rust-lang, string"><title>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='../string/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Crate string</p><div class="sidebar-elems"><a id='all-types' href='all.html'><p>See all string's items</p></a><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'string', ty: 'mod', relpath: '../'};</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 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='../src/string/lib.rs.html#1-320' title='goto source code'>[src]</a></span><span class='in-band'>Crate <a class="mod" href=''>string</a></span></h1><div class='docblock'><p>A UTF-8 encoded string with configurable byte storage.</p>
|
||
<p>This crate provides <code>String</code>, a type similar to its std counterpart, but
|
||
with one significant difference: the underlying byte storage is
|
||
configurable. In other words, <code>String<T></code> is a marker type wrapping <code>T</code>,
|
||
indicating that it represents a UTF-8 encoded string.</p>
|
||
<p>For example, one can represent small strings (stack allocated) by wrapping
|
||
an array:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="ident">s</span>: <span class="ident">String</span><span class="op"><</span>[<span class="ident">u8</span>; <span class="number">2</span>]<span class="op">></span> <span class="op">=</span> <span class="ident">String</span>::<span class="ident">try_from</span>([<span class="string">b'h'</span>, <span class="string">b'i'</span>]).<span class="ident">unwrap</span>();
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="kw-2">&</span><span class="ident">s</span>[..], <span class="string">"hi"</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.String.html" title='string::String struct'>String</a></td><td class='docblock-short'><p>A UTF-8 encoded string with configurable byte storage.</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.StableAsRef.html" title='string::StableAsRef trait'>StableAsRef</a></td><td class='docblock-short'><p>Marker trait that indicates that a type is guaranteed safe to use as backing storage
|
||
for <code>String</code>.</p>
|
||
</td></tr><tr class='module-item'><td><a class="trait" href="trait.TryFrom.html" title='string::TryFrom trait'>TryFrom</a></td><td class='docblock-short'><p>Attempt to construct <code>Self</code> via a conversion.</p>
|
||
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../";window.currentCrate = "string";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |