|
|
<!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 `Error` trait in crate `serde`."><meta name="keywords" content="rust, rustlang, rust-lang, Error"><title>serde::de::Error - 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='../../serde/index.html'><div class='logo-container'><img src='../../rust-logo.png' alt='logo'></div></a><p class='location'>Trait Error</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.custom">custom</a></div><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.duplicate_field">duplicate_field</a><a href="#method.invalid_length">invalid_length</a><a href="#method.invalid_type">invalid_type</a><a href="#method.invalid_value">invalid_value</a><a href="#method.missing_field">missing_field</a><a href="#method.unknown_field">unknown_field</a><a href="#method.unknown_variant">unknown_variant</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: 'Error', 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 js-only"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" 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/serde/de/mod.rs.html#152-286' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='../index.html'>serde</a>::<wbr><a href='index.html'>de</a>::<wbr><a class="trait" href=''>Error</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub trait Error: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/std/error/trait.Error.html" title="trait std::error::Error">Error</a> {
|
|
|
fn <a href='#tymethod.custom' class='fnname'>custom</a><T>(msg: T) -> Self<br> <span class="where">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a></span>;
|
|
|
|
|
|
fn <a href='#method.invalid_type' class='fnname'>invalid_type</a>(unexp: <a class="enum" href="../../serde/de/enum.Unexpected.html" title="enum serde::de::Unexpected">Unexpected</a>, exp: &dyn <a class="trait" href="../../serde/de/trait.Expected.html" title="trait serde::de::Expected">Expected</a>) -> Self { ... }
|
|
|
<div class='item-spacer'></div> fn <a href='#method.invalid_value' class='fnname'>invalid_value</a>(unexp: <a class="enum" href="../../serde/de/enum.Unexpected.html" title="enum serde::de::Unexpected">Unexpected</a>, exp: &dyn <a class="trait" href="../../serde/de/trait.Expected.html" title="trait serde::de::Expected">Expected</a>) -> Self { ... }
|
|
|
<div class='item-spacer'></div> fn <a href='#method.invalid_length' class='fnname'>invalid_length</a>(len: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, exp: &dyn <a class="trait" href="../../serde/de/trait.Expected.html" title="trait serde::de::Expected">Expected</a>) -> Self { ... }
|
|
|
<div class='item-spacer'></div> fn <a href='#method.unknown_variant' class='fnname'>unknown_variant</a>(variant: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, expected: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'static [</a>&'static <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -> Self { ... }
|
|
|
<div class='item-spacer'></div> fn <a href='#method.unknown_field' class='fnname'>unknown_field</a>(field: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, expected: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'static [</a>&'static <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -> Self { ... }
|
|
|
<div class='item-spacer'></div> fn <a href='#method.missing_field' class='fnname'>missing_field</a>(field: &'static <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> Self { ... }
|
|
|
<div class='item-spacer'></div> fn <a href='#method.duplicate_field' class='fnname'>duplicate_field</a>(field: &'static <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> Self { ... }
|
|
|
}</pre></div><div class='docblock'><p>The <code>Error</code> trait allows <code>Deserialize</code> implementations to create descriptive
|
|
|
error messages belonging to the <code>Deserializer</code> against which they are
|
|
|
currently running.</p>
|
|
|
<p>Every <code>Deserializer</code> declares an <code>Error</code> type that encompasses both
|
|
|
general-purpose deserialization errors as well as errors specific to the
|
|
|
particular deserialization format. For example the <code>Error</code> type of
|
|
|
<code>serde_json</code> can represent errors like an invalid JSON escape sequence or an
|
|
|
unterminated string literal, in addition to the error cases that are part of
|
|
|
this trait.</p>
|
|
|
<p>Most deserializers should only need to provide the <code>Error::custom</code> method
|
|
|
and inherit the default behavior for the other methods.</p>
|
|
|
<h1 id="example-implementation" class="section-header"><a href="#example-implementation">Example implementation</a></h1>
|
|
|
<p>The <a href="https://serde.rs/data-format.html">example data format</a> presented on the website shows an error
|
|
|
type appropriate for a basic JSON data format.</p>
|
|
|
</div>
|
|
|
<h2 id='required-methods' class='small-section-header'>Required methods<a href='#required-methods' class='anchor'></a></h2><div class='methods'><h3 id='tymethod.custom' class='method'><code id='custom.v'>fn <a href='#tymethod.custom' class='fnname'>custom</a><T>(msg: T) -> Self <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a>, </span></code></h3><div class='docblock'><p>Raised when there is general error when deserializing a type.</p>
|
|
|
<p>The message should not be capitalized and should not end with a period.</p>
|
|
|
<pre><code class="language-edition2018"># use std::str::FromStr;
|
|
|
#
|
|
|
# struct IpAddr;
|
|
|
#
|
|
|
# impl FromStr for IpAddr {
|
|
|
# type Err = String;
|
|
|
#
|
|
|
# fn from_str(_: &str) -> Result<Self, String> {
|
|
|
# unimplemented!()
|
|
|
# }
|
|
|
# }
|
|
|
#
|
|
|
use serde::de::{self, Deserialize, Deserializer};
|
|
|
|
|
|
impl<'de> Deserialize<'de> for IpAddr {
|
|
|
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
|
|
|
where
|
|
|
D: Deserializer<'de>,
|
|
|
{
|
|
|
let s = String::deserialize(deserializer)?;
|
|
|
s.parse().map_err(de::Error::custom)
|
|
|
}
|
|
|
}
|
|
|
</code></pre>
|
|
|
</div></div><span class='loading-content'>Loading content...</span>
|
|
|
<h2 id='provided-methods' class='small-section-header'>Provided methods<a href='#provided-methods' class='anchor'></a></h2><div class='methods'><h3 id='method.invalid_type' class='method'><code id='invalid_type.v'>fn <a href='#method.invalid_type' class='fnname'>invalid_type</a>(unexp: <a class="enum" href="../../serde/de/enum.Unexpected.html" title="enum serde::de::Unexpected">Unexpected</a>, exp: &dyn <a class="trait" href="../../serde/de/trait.Expected.html" title="trait serde::de::Expected">Expected</a>) -> Self</code></h3><div class='docblock'><p>Raised when a <code>Deserialize</code> receives a type different from what it was
|
|
|
expecting.</p>
|
|
|
<p>The <code>unexp</code> argument provides information about what type was received.
|
|
|
This is the type that was present in the input file or other source data
|
|
|
of the Deserializer.</p>
|
|
|
<p>The <code>exp</code> argument provides information about what type was being
|
|
|
expected. This is the type that is written in the program.</p>
|
|
|
<p>For example if we try to deserialize a String out of a JSON file
|
|
|
containing an integer, the unexpected type is the integer and the
|
|
|
expected type is the string.</p>
|
|
|
</div><h3 id='method.invalid_value' class='method'><code id='invalid_value.v'>fn <a href='#method.invalid_value' class='fnname'>invalid_value</a>(unexp: <a class="enum" href="../../serde/de/enum.Unexpected.html" title="enum serde::de::Unexpected">Unexpected</a>, exp: &dyn <a class="trait" href="../../serde/de/trait.Expected.html" title="trait serde::de::Expected">Expected</a>) -> Self</code></h3><div class='docblock'><p>Raised when a <code>Deserialize</code> receives a value of the right type but that
|
|
|
is wrong for some other reason.</p>
|
|
|
<p>The <code>unexp</code> argument provides information about what value was received.
|
|
|
This is the value that was present in the input file or other source
|
|
|
data of the Deserializer.</p>
|
|
|
<p>The <code>exp</code> argument provides information about what value was being
|
|
|
expected. This is the type that is written in the program.</p>
|
|
|
<p>For example if we try to deserialize a String out of some binary data
|
|
|
that is not valid UTF-8, the unexpected value is the bytes and the
|
|
|
expected value is a string.</p>
|
|
|
</div><h3 id='method.invalid_length' class='method'><code id='invalid_length.v'>fn <a href='#method.invalid_length' class='fnname'>invalid_length</a>(len: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, exp: &dyn <a class="trait" href="../../serde/de/trait.Expected.html" title="trait serde::de::Expected">Expected</a>) -> Self</code></h3><div class='docblock'><p>Raised when deserializing a sequence or map and the input data contains
|
|
|
too many or too few elements.</p>
|
|
|
<p>The <code>len</code> argument is the number of elements encountered. The sequence
|
|
|
or map may have expected more arguments or fewer arguments.</p>
|
|
|
<p>The <code>exp</code> argument provides information about what data was being
|
|
|
expected. For example <code>exp</code> might say that a tuple of size 6 was
|
|
|
expected.</p>
|
|
|
</div><h3 id='method.unknown_variant' class='method'><code id='unknown_variant.v'>fn <a href='#method.unknown_variant' class='fnname'>unknown_variant</a>(variant: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, expected: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'static [</a>&'static <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -> Self</code></h3><div class='docblock'><p>Raised when a <code>Deserialize</code> enum type received a variant with an
|
|
|
unrecognized name.</p>
|
|
|
</div><h3 id='method.unknown_field' class='method'><code id='unknown_field.v'>fn <a href='#method.unknown_field' class='fnname'>unknown_field</a>(field: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, expected: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'static [</a>&'static <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -> Self</code></h3><div class='docblock'><p>Raised when a <code>Deserialize</code> struct type received a field with an
|
|
|
unrecognized name.</p>
|
|
|
</div><h3 id='method.missing_field' class='method'><code id='missing_field.v'>fn <a href='#method.missing_field' class='fnname'>missing_field</a>(field: &'static <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> Self</code></h3><div class='docblock'><p>Raised when a <code>Deserialize</code> struct type expected to receive a required
|
|
|
field with a particular name but that field was not present in the
|
|
|
input.</p>
|
|
|
</div><h3 id='method.duplicate_field' class='method'><code id='duplicate_field.v'>fn <a href='#method.duplicate_field' class='fnname'>duplicate_field</a>(field: &'static <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> Self</code></h3><div class='docblock'><p>Raised when a <code>Deserialize</code> struct type received more than one of the
|
|
|
same field.</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-Error' class='impl'><code class='in-band'>impl Error for <a class="struct" href="../../serde/de/value/struct.Error.html" title="struct serde::de::value::Error">Error</a></code><a href='#impl-Error' class='anchor'></a><a class='srclink' href='../../src/serde/de/value.rs.html#61-82' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.custom' class="method hidden"><code id='custom.v-1'>fn <a href='#method.custom' class='fnname'>custom</a><T>(msg: T) -> Self <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a>, </span></code><a class='srclink' href='../../src/serde/de/value.rs.html#64-71' title='goto source code'>[src]</a></h4></div></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.Error.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>⏎</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> |
