doc: 2020-04-01 11:32:45 +0200: 478563f - Adding documentation
This commit is contained in:
3
string/all.html
Normal file
3
string/all.html
Normal file
@@ -0,0 +1,3 @@
|
||||
<!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="List of all items in this crate"><meta name="keywords" content="rust, rustlang, rust-lang"><title>List of all items in this crate</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></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>
|
||||
</span>
|
||||
<span class='in-band'>List of all items</span></h1><h3 id='Structs'>Structs</h3><ul class='structs docblock'><li><a href='struct.String.html'>String</a></li></ul><h3 id='Traits'>Traits</h3><ul class='traits docblock'><li><a href='trait.StableAsRef.html'>StableAsRef</a></li><li><a href='trait.TryFrom.html'>TryFrom</a></li></ul></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>
|
||||
18
string/index.html
Normal file
18
string/index.html
Normal file
@@ -0,0 +1,18 @@
|
||||
<!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>
|
||||
1
string/sidebar-items.js
Normal file
1
string/sidebar-items.js
Normal file
@@ -0,0 +1 @@
|
||||
initSidebarItems({"struct":[["String","A UTF-8 encoded string with configurable byte storage."]],"trait":[["StableAsRef","Marker trait that indicates that a type is guaranteed safe to use as backing storage for `String`."],["TryFrom","Attempt to construct `Self` via a conversion."]]});
|
||||
98
string/struct.String.html
Normal file
98
string/struct.String.html
Normal file
File diff suppressed because one or more lines are too long
30
string/trait.StableAsRef.html
Normal file
30
string/trait.StableAsRef.html
Normal file
File diff suppressed because one or more lines are too long
12
string/trait.TryFrom.html
Normal file
12
string/trait.TryFrom.html
Normal file
@@ -0,0 +1,12 @@
|
||||
<!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 `TryFrom` trait in crate `string`."><meta name="keywords" content="rust, rustlang, rust-lang, TryFrom"><title>string::TryFrom - 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='../string/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Trait TryFrom</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#associated-types">Associated Types</a><div class="sidebar-links"><a href="#associatedtype.Error">Error</a></div><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.try_from">try_from</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='index.html'>string</a></p><script>window.sidebarCurrent = {name: 'TryFrom', 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 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#235-241' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='index.html'>string</a>::<wbr><a class="trait" href=''>TryFrom</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub trait TryFrom<T>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + Sealed {
|
||||
type <a href='#associatedtype.Error' class="type">Error</a>;
|
||||
fn <a href='#tymethod.try_from' class='fnname'>try_from</a>(value: T) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, Self::<a class="type" href="../string/trait.TryFrom.html#associatedtype.Error" title="type string::TryFrom::Error">Error</a>>;
|
||||
}</pre></div><div class='docblock'><p>Attempt to construct <code>Self</code> via a conversion.</p>
|
||||
<p>This trait will be deprecated in favor of [std::convert::TryFrom] once it
|
||||
reaches stable Rust.</p>
|
||||
</div>
|
||||
<h2 id='associated-types' class='small-section-header'>Associated Types<a href='#associated-types' class='anchor'></a></h2><div class='methods'><h3 id='associatedtype.Error' class='method'><code id='Error.t'>type <a href='#associatedtype.Error' class="type">Error</a></code></h3><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||||
</div></div><span class='loading-content'>Loading content...</span>
|
||||
<h2 id='required-methods' class='small-section-header'>Required methods<a href='#required-methods' class='anchor'></a></h2><div class='methods'><h3 id='tymethod.try_from' class='method'><code id='try_from.v'>fn <a href='#tymethod.try_from' class='fnname'>try_from</a>(value: T) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, Self::<a class="type" href="../string/trait.TryFrom.html#associatedtype.Error" title="type string::TryFrom::Error">Error</a>></code></h3><div class='docblock'><p>Performs the conversion.</p>
|
||||
</div></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-TryFrom%3CT%3E' class='impl'><code class='in-band'>impl<T> TryFrom<T> for <a class="struct" href="../string/struct.String.html" title="struct string::String">String</a><T> <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>> + <a class="trait" href="../string/trait.StableAsRef.html" title="trait string::StableAsRef">StableAsRef</a>, </span></code><a href='#impl-TryFrom%3CT%3E' class='anchor'></a><a class='srclink' href='../src/string/lib.rs.html#208-217' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Error-1' class="type"><code id='Error.t-1'>type <a href='#associatedtype.Error-1' class="type">Error</a> = <a class="struct" href="https://doc.rust-lang.org/nightly/core/str/struct.Utf8Error.html" title="struct core::str::Utf8Error">Utf8Error</a></code></h4><h4 id='method.try_from' class="method hidden"><code id='try_from.v-1'>fn <a href='#method.try_from' class='fnname'>try_from</a>(value: T) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, Self::<a class="type" href="../string/trait.TryFrom.html#associatedtype.Error" title="type string::TryFrom::Error">Error</a>></code><a class='srclink' href='../src/string/lib.rs.html#213-216' title='goto source code'>[src]</a></h4></div></div><span class='loading-content'>Loading content...</span><script type="text/javascript" src="../implementors/string/trait.TryFrom.js" async></script></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>
|
||||
Reference in New Issue
Block a user