You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Trac3r-rust/doc/serde/de/trait.IntoDeserializer.html

37 lines
52 KiB

5 years ago
<!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 `IntoDeserializer` trait in crate `serde`."><meta name="keywords" content="rust, rustlang, rust-lang, IntoDeserializer"><title>serde::de::IntoDeserializer - 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">&#9776;</div><a href='../../serde/index.html'><div class='logo-container'><img src='../../rust-logo.png' alt='logo'></div></a><p class='location'>Trait IntoDeserializer</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.Deserializer">Deserializer</a></div><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.into_deserializer">into_deserializer</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-IntoDeserializer%3C%27de%2C%20E%3E-for-%26%27a%20str">&amp;&#39;a str</a><a href="#impl-IntoDeserializer%3C%27de%2C%20E%3E-for-()">()</a><a href="#impl-IntoDeserializer%3C%27de%2C%20E%3E-for-BTreeMap%3CK%2C%20V%3E">BTreeMap&lt;K, V&gt;</a><a href="#impl-IntoDeserializer%3C%27de%2C%20E%3E-for-BTreeSet%3CT%3E">BTreeSet&lt;T&gt;</a><a href="#impl-IntoDeserializer%3C%27de%2C%20E%3E-for-Cow%3C%27a%2C%20str%3E">Cow&lt;&#39;a, str&gt;</a><a href="#impl-IntoDeserializer%3C%27de%2C%20E%3E-for-HashMap%3CK%2C%20V%2C%20S%3E">HashMap&lt;K, V, S&gt;</a><a href="#impl-IntoDeserializer%3C%27de%2C%20E%3E-for-HashSet%3CT%2C%20S%3E">HashSet&lt;T, S&gt;</a><a href="#impl-IntoDeserializer%3C%27de%2C%20E%3E-for-String">String</a><a href="#impl-IntoDeserializer%3C%27de%2C%20E%3E-for-Vec%3CT%3E">Vec&lt;T&gt;</a><a href="#impl-IntoDeserializer%3C%27de%2C%20E%3E-for-bool">bool</a><a href="#impl-IntoDeserializer%3C%27de%2C%20E%3E-for-char">char</a><a href="#impl-IntoDeserializer%3C%27de%2C%20E%3E-for-f32">f32</a><a href="#impl-IntoDeserializer%3C%27de%2C%20E%3E-for-f64">f64</a><a href="#impl-IntoDeserializer%3C%27de%2C%20E%3E-for-i128">i128</a><a href="#impl-IntoDeserializer%3C%27de%2C%20E%3E-for-i16">i16</a><a href="#impl-IntoDeserializer%3C%27de%2C%20E%3E-for-i32">i32</a><a href="#impl-IntoDeserializer%3C%27de%2C%20E%3E-for-i64">i64</a><a href="#impl-IntoDeserializer%3C%27de%2C%20E%3E-for-i8">i8</a><a href="#impl-IntoDeserializer%3C%27de%2C%20E%3E-for-isize">isize</a><a href="#impl-IntoDeserializer%3C%27de%2C%20E%3E-for-u128">u128</a><a href="#impl-IntoDeserializer%3C%27de%2C%20E%3E-for-u16">u16</a><a href="#impl-IntoDeserializer%3C%27de%2C%20E%3E-for-u32">u32</a><a href="#impl-IntoDeserializer%3C%27de%2C%20E%3E-for-u64">u64</a><a href="#impl-IntoDeserializer%3C%27de%2C%20E%3E-for-u8">u8</a><a href="#impl-IntoDeserializer%3C%27de%2C%20E%3E-for-usize">usize</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='../index.html'>serde</a>::<wbr><a href='index.html'>de</a></p><script>window.sidebarCurrent = {name: 'IntoDeserializer', 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!"
type <a href='#associatedtype.Deserializer' class="type">Deserializer</a>: <a class="trait" href="../../serde/trait.Deserializer.html" title="trait serde::Deserializer">Deserializer</a>&lt;'de, Error = E&gt;;
fn <a href='#tymethod.into_deserializer' class='fnname'>into_deserializer</a>(self) -&gt; Self::<a class="type" href="../../serde/de/trait.IntoDeserializer.html#associatedtype.Deserializer" title="type serde::de::IntoDeserializer::Deserializer">Deserializer</a>;
}</pre></div><div class='docblock'><p>Converts an existing value into a <code>Deserializer</code> from which other values can
be deserialized.</p>
<h1 id="lifetime" class="section-header"><a href="#lifetime">Lifetime</a></h1>
<p>The <code>'de</code> lifetime of this trait is the lifetime of data that may be
borrowed from the resulting <code>Deserializer</code>. See the page <a href="https://serde.rs/lifetimes.html">Understanding
deserializer lifetimes</a> for a more detailed explanation of these lifetimes.</p>
<h1 id="example" class="section-header"><a href="#example">Example</a></h1>
<pre><code class="language-edition2018">use std::str::FromStr;
use serde::Deserialize;
use serde::de::{value, IntoDeserializer};
#[derive(Deserialize)]
enum Setting {
On,
Off,
}
impl FromStr for Setting {
type Err = value::Error;
fn from_str(s: &amp;str) -&gt; Result&lt;Self, Self::Err&gt; {
Self::deserialize(s.into_deserializer())
}
}
</code></pre>
</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.Deserializer' class='method'><code id='Deserializer.t'>type <a href='#associatedtype.Deserializer' class="type">Deserializer</a>: <a class="trait" href="../../serde/trait.Deserializer.html" title="trait serde::Deserializer">Deserializer</a>&lt;'de, Error = E&gt;</code></h3><div class='docblock'><p>The type of the deserializer being converted into.</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.into_deserializer' class='method'><code id='into_deserializer.v'>fn <a href='#tymethod.into_deserializer' class='fnname'>into_deserializer</a>(self) -&gt; Self::<a class="type" href="../../serde/de/trait.IntoDeserializer.html#associatedtype.Deserializer" title="type serde::de::IntoDeserializer::Deserializer">Deserializer</a></code></h3><div class='docblock'><p>Convert this value into a deserializer.</p>
</div></div><span class='loading-content'>Loading content...</span>
<h2 id='foreign-impls' class='small-section-header'>Implementations on Foreign Types<a href='#foreign-impls' class='anchor'></a></h2><h3 id='impl-IntoDeserializer%3C%27de%2C%20E%3E-for-()' class='impl'><code class='in-band'>impl&lt;'de, E&gt; <a class="trait" href="../../serde/de/trait.IntoDeserializer.html" title="trait serde::de::IntoDeserializer">IntoDeserializer</a>&lt;'de, E&gt; for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a> <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;E: <a class="trait" href="../../serde/de/trait.Error.html" title="trait serde::de::Error">Error</a>,&nbsp;</span></code><a href='#impl-IntoDeserializer%3C%27de%2C%20E%3E-for-()' class='anchor'></a><a class='srclink' href='../../src/serde/de/value.rs.html#115-126' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Deserializer-1' class="type"><code id='Deserializer.t-1'>type <a href='#associatedtype.Deserializer' class="type">Deserializer</a> = <a class="struct" href="../../serde/de/value/struct.UnitDeserializer.html" title="struct serde::de::value::UnitDeserializer">UnitDeserializer</a>&lt;E&gt;</code></h4><h4 id='method.into_deserializer' class="method hidden"><code id='into_deserializer.v-1'>fn <a href='#method.into_deserializer' class='fnname'>into_deserializer</a>(self) -&gt; <a class="struct" href="../../serde/de/value/struct.UnitDeserializer.html" title="struct serde::de::value::UnitDeserializer">UnitDeserializer</a>&lt;E&gt;</code><a class='srclink' href='../../src/serde/de/value.rs.html#121-125' title='goto source code'>[src]</a></h4></div><h3 id='impl-IntoDeserializer%3C%27de%2C%20E%3E-for-bool' class='impl'><code class='in-band'>impl&lt;'de, E&gt; <a class="trait" href="../../serde/de/trait.IntoDeserializer.html" title="trait serde::de::IntoDeserializer">IntoDeserializer</a>&lt;'de, E&gt; for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a> <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;E: <a class="trait" href="../../serde/de/trait.Error.html" title="trait serde::de::Error">Error</a>,&nbsp;</span></code><a href='#impl-IntoDeserializer%3C%27de%2C%20E%3E-for-bool' class='anchor'></a><a class='srclink' href='../../src/serde/de/value.rs.html#219-231' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Deserializer-2' class="type"><code id='Deserializer.t-2'>type <a href='#associatedtype.Deserializer' class="type">Deserializer</a> = <a class="struct" href="../../serde/de/value/struct.BoolDeserializer.html" title="struct serde::de::value::BoolDeserializer">BoolDeserializer</a>&lt;E&gt;</code></h4><h4 id='method.into_deserializer-1' class="method hidden"><code id='into_deserializer.v-2'>fn <a href='#method.into_deserializer' class='fnname'>into_deserializer</a>(self) -&gt; <a class="struct" href="../../serde/de/value/struct.BoolDeserializer.html" title="struct serde::de::value::BoolDeserializer">BoolDeserializer</a>&lt;E&gt;</code><a class='srclink' href='../../src/serde/de/value.rs.html#225-230' title='goto source code'>[src]</a></h4></div><h3 id='impl-IntoDeserializer%3C%27de%2C%20E%3E-for-i8' class='impl'><code class='in-band'>impl&lt;'de, E&gt; <a class="trait" href="../../serde/de/trait.IntoDeserializer.html" title="trait serde::de::IntoDeserializer">IntoDeserializer</a>&lt;'de, E&gt; for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i8.html">i8</a> <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;E: <a class="trait" href="../../serde/de/trait.Error.html" title="trait serde::de::Error">Error</a>,&nbsp;</span></code><a href='#impl-IntoDeserializer%3C%27de%2C%20E%3E-for-i8' class='anchor'></a><a class='srclink' href='../../src/serde/de/value.rs.html#219-231' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Deserializer-3' class="type"><code id='Deserializer.t-3'>type <a href='#associatedtype.Deserializer' class="type">Deserializer</a> = <a class="struc
<h2 id='implementors' class='small-section-header'>Implementors<a href='#implementors' class='anchor'></a></h2><div class='item-list' id='implementors-list'></div><span class='loading-content'>Loading content...</span><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
src="../../implementors/serde/de/trait.IntoDeserializer.js">
</script></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><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../";window.currentCrate = "serde";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>