mentat/serde_json/de/struct.StrRead.html

149 lines
13 KiB
HTML
Raw Normal View History

2018-08-22 17:04:13 +00:00
<!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 `StrRead` struct in crate `serde_json`.">
<meta name="keywords" content="rust, rustlang, rust-lang, StrRead">
<title>serde_json::de::StrRead - 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="../../main.css" id="themeStyle">
<script src="../../storage.js"></script>
</head>
<body class="rustdoc struct">
<!--[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">&#9776;</div>
<p class='location'>Struct StrRead</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.new">new</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Read%3C%27a%3E">Read&lt;&#39;a&gt;</a></div></div><p class='location'><a href='../index.html'>serde_json</a>::<wbr><a href='index.html'>de</a></p><script>window.sidebarCurrent = {name: 'StrRead', ty: 'struct', 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 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">
<h1 class='fqn'><span class='in-band'>Struct <a href='../index.html'>serde_json</a>::<wbr><a href='index.html'>de</a>::<wbr><a class="struct" href=''>StrRead</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 class='srclink' href='../../src/serde_json/read.rs.html#125-127' title='goto source code'>[src]</a></span></h1>
<pre class='rust struct'>pub struct StrRead&lt;'a&gt; { /* fields omitted */ }</pre><div class='docblock'><p>JSON input source that reads from a UTF-8 string.</p>
</div>
<h2 id='methods' class='small-section-header'>
Methods<a href='#methods' class='anchor'></a>
</h2>
<h3 id='impl' class='impl'><span class='in-band'><code>impl&lt;'a&gt; <a class="struct" href="../../serde_json/de/struct.StrRead.html" title="struct serde_json::de::StrRead">StrRead</a>&lt;'a&gt;</code><a href='#impl' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/serde_json/read.rs.html#444-451' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><code>pub fn <a href='#method.new' class='fnname'>new</a>(s: &amp;'a <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -&gt; Self</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/serde_json/read.rs.html#446-450' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Create a JSON input source to read from a UTF-8 string.</p>
</div></div>
<h2 id='implementations' class='small-section-header'>
Trait Implementations<a href='#implementations' class='anchor'></a>
</h2>
<h3 id='impl-Read%3C%27a%3E' class='impl'><span class='in-band'><code>impl&lt;'a&gt; <a class="trait" href="../../serde_json/de/trait.Read.html" title="trait serde_json::de::Read">Read</a>&lt;'a&gt; for <a class="struct" href="../../serde_json/de/struct.StrRead.html" title="struct serde_json::de::StrRead">StrRead</a>&lt;'a&gt;</code><a href='#impl-Read%3C%27a%3E' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/serde_json/read.rs.html#455-501' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.next' class="method"><span id='next.v' class='invisible'><code>fn <a href='../../serde_json/de/trait.Read.html#tymethod.next' class='fnname'>next</a>(&amp;mut self) -&gt; <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a>&lt;<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>&gt;&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/serde_json/read.rs.html#457-459' title='goto source code'>[src]</a></span></h4>
<h4 id='method.peek' class="method"><span id='peek.v' class='invisible'><code>fn <a href='../../serde_json/de/trait.Read.html#tymethod.peek' class='fnname'>peek</a>(&amp;mut self) -&gt; <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a>&lt;<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>&gt;&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/serde_json/read.rs.html#462-464' title='goto source code'>[src]</a></span></h4>
<h4 id='method.discard' class="method"><span id='discard.v' class='invisible'><code>fn <a href='../../serde_json/de/trait.Read.html#tymethod.discard' class='fnname'>discard</a>(&amp;mut self)</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/serde_json/read.rs.html#467-469' title='goto source code'>[src]</a></span></h4>
<h4 id='method.position' class="method"><span id='position.v' class='invisible'><code>fn <a href='../../serde_json/de/trait.Read.html#tymethod.position' class='fnname'>position</a>(&amp;self) -&gt; Position</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/serde_json/read.rs.html#471-473' title='goto source code'>[src]</a></span></h4>
<h4 id='method.peek_position' class="method"><span id='peek_position.v' class='invisible'><code>fn <a href='../../serde_json/de/trait.Read.html#tymethod.peek_position' class='fnname'>peek_position</a>(&amp;self) -&gt; Position</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/serde_json/read.rs.html#475-477' title='goto source code'>[src]</a></span></h4>
<h4 id='method.byte_offset' class="method"><span id='byte_offset.v' class='invisible'><code>fn <a href='../../serde_json/de/trait.Read.html#tymethod.byte_offset' class='fnname'>byte_offset</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/serde_json/read.rs.html#479-481' title='goto source code'>[src]</a></span></h4>
<h4 id='method.parse_str' class="method"><span id='parse_str.v' class='invisible'><code>fn <a href='../../serde_json/de/trait.Read.html#tymethod.parse_str' class='fnname'>parse_str</a>&lt;'s&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;'s mut self, <br>&nbsp;&nbsp;&nbsp;&nbsp;scratch: &amp;'s mut <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>&gt;<br>) -&gt; <a class="type" href="../../serde_json/type.Result.html" title="type serde_json::Result">Result</a>&lt;Reference&lt;'a, 's, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>&gt;&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/serde_json/read.rs.html#483-489' title='goto source code'>[src]</a></span></h4>
<h4 id='method.parse_str_raw' class="method"><span id='parse_str_raw.v' class='invisible'><code>fn <a href='../../serde_json/de/trait.Read.html#tymethod.parse_str_raw' class='fnname'>parse_str_raw</a>&lt;'s&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;'s mut self, <br>&nbsp;&nbsp;&nbsp;&nbsp;scratch: &amp;'s mut <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>&gt;<br>) -&gt; <a class="type" href="../../serde_json/type.Result.html" title="type serde_json::Result">Result</a>&lt;Reference&lt;'a, 's, <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>&gt;&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/serde_json/read.rs.html#491-496' title='goto source code'>[src]</a></span></h4>
<h4 id='method.ignore_str' class="method"><span id='ignore_str.v' class='invisible'><code>fn <a href='../../serde_json/de/trait.Read.html#tymethod.ignore_str' class='fnname'>ignore_str</a>(&amp;mut self) -&gt; <a class="type" href="../../serde_json/type.Result.html" title="type serde_json::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/serde_json/read.rs.html#498-500' title='goto source code'>[src]</a></span></h4>
</div></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><kbd>?</kbd></dt>
<dd>Show this help dialog</dd>
<dt><kbd>S</kbd></dt>
<dd>Focus the search field</dd>
<dt><kbd></kbd></dt>
<dd>Move up in search results</dd>
<dt><kbd></kbd></dt>
<dd>Move down in search results</dd>
<dt><kbd></kbd></dt>
<dd>Switch tab</dd>
<dt><kbd>&#9166;</kbd></dt>
<dd>Go to active search result</dd>
<dt><kbd>+</kbd></dt>
<dd>Expand all sections</dd>
<dt><kbd>-</kbd></dt>
<dd>Collapse all sections</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 = "serde_json";
</script>
<script src="../../main.js"></script>
<script defer src="../../search-index.js"></script>
</body>
</html>