Now a REAL lib
This commit is contained in:
1
doc/serde_json/all.html
Normal file
1
doc/serde_json/all.html
Normal file
File diff suppressed because one or more lines are too long
81
doc/serde_json/de/fn.from_reader.html
Normal file
81
doc/serde_json/de/fn.from_reader.html
Normal file
@ -0,0 +1,81 @@
|
||||
<!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="Deserialize an instance of type `T` from an IO stream of JSON."><meta name="keywords" content="rust, rustlang, rust-lang, from_reader"><title>from_reader in serde_json::de - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../../serde_json/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../serde_json/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In serde_json::de</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../serde_json/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Function <a href="../index.html">serde_json</a>::<wbr><a href="index.html">de</a>::<wbr><a class="fn" href="#">from_reader</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../src/serde_json/de.rs.html#2516-2522">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub fn from_reader<R, T>(rdr: R) -> <a class="type" href="../type.Result.html" title="type serde_json::Result">Result</a><T> <span class="where fmt-newline">where<br> R: <a class="trait" href="https://doc.rust-lang.org/1.64.0/std/io/trait.Read.html" title="trait std::io::Read">Read</a>,<br> T: <a class="trait" href="../../serde/de/trait.DeserializeOwned.html" title="trait serde::de::DeserializeOwned">DeserializeOwned</a>, </span></code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Deserialize an instance of type <code>T</code> from an IO stream of JSON.</p>
|
||||
<p>The content of the IO stream is deserialized directly from the stream
|
||||
without being buffered in memory by serde_json.</p>
|
||||
<p>When reading from a source against which short reads are not efficient, such
|
||||
as a <a href="https://doc.rust-lang.org/std/fs/struct.File.html"><code>File</code></a>, you will want to apply your own buffering because serde_json
|
||||
will not buffer the input. See <a href="https://doc.rust-lang.org/std/io/struct.BufReader.html"><code>std::io::BufReader</code></a>.</p>
|
||||
<p>It is expected that the input stream ends after the deserialized object.
|
||||
If the stream does not end, such as in the case of a persistent socket connection,
|
||||
this function will not return. It is possible instead to deserialize from a prefix of an input
|
||||
stream without looking for EOF by managing your own <a href="../struct.Deserializer.html" title="Deserializer"><code>Deserializer</code></a>.</p>
|
||||
<p>Note that counter to intuition, this function is usually slower than
|
||||
reading a file completely into memory and then applying <a href="./fn.from_str.html"><code>from_str</code></a>
|
||||
or <a href="./fn.from_slice.html"><code>from_slice</code></a> on it. See <a href="https://github.com/serde-rs/json/issues/160">issue #160</a>.</p>
|
||||
<h2 id="example"><a href="#example">Example</a></h2>
|
||||
<p>Reading the contents of a file.</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">serde::Deserialize</span>;
|
||||
|
||||
<span class="kw">use</span> <span class="ident">std::error::Error</span>;
|
||||
<span class="kw">use</span> <span class="ident">std::fs::File</span>;
|
||||
<span class="kw">use</span> <span class="ident">std::io::BufReader</span>;
|
||||
<span class="kw">use</span> <span class="ident">std::path::Path</span>;
|
||||
|
||||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Deserialize</span>, <span class="ident">Debug</span>)]</span>
|
||||
<span class="kw">struct</span> <span class="ident">User</span> {
|
||||
<span class="ident">fingerprint</span>: <span class="ident">String</span>,
|
||||
<span class="ident">location</span>: <span class="ident">String</span>,
|
||||
}
|
||||
|
||||
<span class="kw">fn</span> <span class="ident">read_user_from_file</span><span class="op"><</span><span class="ident">P</span>: <span class="ident">AsRef</span><span class="op"><</span><span class="ident">Path</span><span class="op">></span><span class="op">></span>(<span class="ident">path</span>: <span class="ident">P</span>) -> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">User</span>, <span class="ident">Box</span><span class="op"><</span><span class="kw">dyn</span> <span class="ident">Error</span><span class="op">></span><span class="op">></span> {
|
||||
<span class="comment">// Open the file in read-only mode with buffer.</span>
|
||||
<span class="kw">let</span> <span class="ident">file</span> <span class="op">=</span> <span class="ident">File::open</span>(<span class="ident">path</span>)<span class="question-mark">?</span>;
|
||||
<span class="kw">let</span> <span class="ident">reader</span> <span class="op">=</span> <span class="ident">BufReader::new</span>(<span class="ident">file</span>);
|
||||
|
||||
<span class="comment">// Read the JSON contents of the file as an instance of `User`.</span>
|
||||
<span class="kw">let</span> <span class="ident">u</span> <span class="op">=</span> <span class="ident">serde_json::from_reader</span>(<span class="ident">reader</span>)<span class="question-mark">?</span>;
|
||||
|
||||
<span class="comment">// Return the `User`.</span>
|
||||
<span class="prelude-val">Ok</span>(<span class="ident">u</span>)
|
||||
}
|
||||
|
||||
<span class="kw">fn</span> <span class="ident">main</span>() {
|
||||
<span class="kw">let</span> <span class="ident">u</span> <span class="op">=</span> <span class="ident">read_user_from_file</span>(<span class="string">"test.json"</span>).<span class="ident">unwrap</span>();
|
||||
<span class="macro">println!</span>(<span class="string">"{:#?}"</span>, <span class="ident">u</span>);
|
||||
}</code></pre></div>
|
||||
<p>Reading from a persistent socket connection.</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">serde::Deserialize</span>;
|
||||
|
||||
<span class="kw">use</span> <span class="ident">std::error::Error</span>;
|
||||
<span class="kw">use</span> <span class="ident">std::net</span>::{<span class="ident">TcpListener</span>, <span class="ident">TcpStream</span>};
|
||||
|
||||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Deserialize</span>, <span class="ident">Debug</span>)]</span>
|
||||
<span class="kw">struct</span> <span class="ident">User</span> {
|
||||
<span class="ident">fingerprint</span>: <span class="ident">String</span>,
|
||||
<span class="ident">location</span>: <span class="ident">String</span>,
|
||||
}
|
||||
|
||||
<span class="kw">fn</span> <span class="ident">read_user_from_stream</span>(<span class="ident">tcp_stream</span>: <span class="ident">TcpStream</span>) -> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">User</span>, <span class="ident">Box</span><span class="op"><</span><span class="kw">dyn</span> <span class="ident">Error</span><span class="op">></span><span class="op">></span> {
|
||||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">de</span> <span class="op">=</span> <span class="ident">serde_json::Deserializer::from_reader</span>(<span class="ident">tcp_stream</span>);
|
||||
<span class="kw">let</span> <span class="ident">u</span> <span class="op">=</span> <span class="ident">User::deserialize</span>(<span class="kw-2">&mut</span> <span class="ident">de</span>)<span class="question-mark">?</span>;
|
||||
|
||||
<span class="prelude-val">Ok</span>(<span class="ident">u</span>)
|
||||
}
|
||||
|
||||
<span class="kw">fn</span> <span class="ident">main</span>() {
|
||||
<span class="kw">let</span> <span class="ident">listener</span> <span class="op">=</span> <span class="ident">TcpListener::bind</span>(<span class="string">"127.0.0.1:4000"</span>).<span class="ident">unwrap</span>();
|
||||
|
||||
<span class="kw">for</span> <span class="ident">stream</span> <span class="kw">in</span> <span class="ident">listener</span>.<span class="ident">incoming</span>() {
|
||||
<span class="macro">println!</span>(<span class="string">"{:#?}"</span>, <span class="ident">read_user_from_stream</span>(<span class="ident">stream</span>.<span class="ident">unwrap</span>()));
|
||||
}
|
||||
}</code></pre></div>
|
||||
<h2 id="errors"><a href="#errors">Errors</a></h2>
|
||||
<p>This conversion can fail if the structure of the input does not match the
|
||||
structure expected by <code>T</code>, for example if <code>T</code> is a struct type but the input
|
||||
contains something other than a JSON map. It can also fail if the structure
|
||||
is correct but <code>T</code>’s implementation of <code>Deserialize</code> decides that something
|
||||
is wrong with the data, for example required struct fields are missing from
|
||||
the JSON map or some number is too big to fit in the expected primitive
|
||||
type.</p>
|
||||
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="serde_json" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>
|
||||
30
doc/serde_json/de/fn.from_slice.html
Normal file
30
doc/serde_json/de/fn.from_slice.html
Normal file
@ -0,0 +1,30 @@
|
||||
<!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="Deserialize an instance of type `T` from bytes of JSON text."><meta name="keywords" content="rust, rustlang, rust-lang, from_slice"><title>from_slice in serde_json::de - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../../serde_json/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../serde_json/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In serde_json::de</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../serde_json/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Function <a href="../index.html">serde_json</a>::<wbr><a href="index.html">de</a>::<wbr><a class="fn" href="#">from_slice</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../src/serde_json/de.rs.html#2559-2564">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub fn from_slice<'a, T>(v: &'a [<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.u8.html">u8</a>]) -> <a class="type" href="../type.Result.html" title="type serde_json::Result">Result</a><T> <span class="where fmt-newline">where<br> T: <a class="trait" href="../../serde/de/trait.Deserialize.html" title="trait serde::de::Deserialize">Deserialize</a><'a>, </span></code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Deserialize an instance of type <code>T</code> from bytes of JSON text.</p>
|
||||
<h2 id="example"><a href="#example">Example</a></h2>
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">serde::Deserialize</span>;
|
||||
|
||||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Deserialize</span>, <span class="ident">Debug</span>)]</span>
|
||||
<span class="kw">struct</span> <span class="ident">User</span> {
|
||||
<span class="ident">fingerprint</span>: <span class="ident">String</span>,
|
||||
<span class="ident">location</span>: <span class="ident">String</span>,
|
||||
}
|
||||
|
||||
<span class="kw">fn</span> <span class="ident">main</span>() {
|
||||
<span class="comment">// The type of `j` is `&[u8]`</span>
|
||||
<span class="kw">let</span> <span class="ident">j</span> <span class="op">=</span> <span class="string">b"
|
||||
{
|
||||
\"fingerprint\": \"0xF9BA143B95FF6D82\",
|
||||
\"location\": \"Menlo Park, CA\"
|
||||
}"</span>;
|
||||
|
||||
<span class="kw">let</span> <span class="ident">u</span>: <span class="ident">User</span> <span class="op">=</span> <span class="ident">serde_json::from_slice</span>(<span class="ident">j</span>).<span class="ident">unwrap</span>();
|
||||
<span class="macro">println!</span>(<span class="string">"{:#?}"</span>, <span class="ident">u</span>);
|
||||
}</code></pre></div>
|
||||
<h2 id="errors"><a href="#errors">Errors</a></h2>
|
||||
<p>This conversion can fail if the structure of the input does not match the
|
||||
structure expected by <code>T</code>, for example if <code>T</code> is a struct type but the input
|
||||
contains something other than a JSON map. It can also fail if the structure
|
||||
is correct but <code>T</code>’s implementation of <code>Deserialize</code> decides that something
|
||||
is wrong with the data, for example required struct fields are missing from
|
||||
the JSON map or some number is too big to fit in the expected primitive
|
||||
type.</p>
|
||||
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="serde_json" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>
|
||||
30
doc/serde_json/de/fn.from_str.html
Normal file
30
doc/serde_json/de/fn.from_str.html
Normal file
@ -0,0 +1,30 @@
|
||||
<!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="Deserialize an instance of type `T` from a string of JSON text."><meta name="keywords" content="rust, rustlang, rust-lang, from_str"><title>from_str in serde_json::de - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../../serde_json/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../serde_json/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In serde_json::de</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../serde_json/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Function <a href="../index.html">serde_json</a>::<wbr><a href="index.html">de</a>::<wbr><a class="fn" href="#">from_str</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../src/serde_json/de.rs.html#2601-2606">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub fn from_str<'a, T>(s: &'a <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.str.html">str</a>) -> <a class="type" href="../type.Result.html" title="type serde_json::Result">Result</a><T> <span class="where fmt-newline">where<br> T: <a class="trait" href="../../serde/de/trait.Deserialize.html" title="trait serde::de::Deserialize">Deserialize</a><'a>, </span></code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Deserialize an instance of type <code>T</code> from a string of JSON text.</p>
|
||||
<h2 id="example"><a href="#example">Example</a></h2>
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">serde::Deserialize</span>;
|
||||
|
||||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Deserialize</span>, <span class="ident">Debug</span>)]</span>
|
||||
<span class="kw">struct</span> <span class="ident">User</span> {
|
||||
<span class="ident">fingerprint</span>: <span class="ident">String</span>,
|
||||
<span class="ident">location</span>: <span class="ident">String</span>,
|
||||
}
|
||||
|
||||
<span class="kw">fn</span> <span class="ident">main</span>() {
|
||||
<span class="comment">// The type of `j` is `&str`</span>
|
||||
<span class="kw">let</span> <span class="ident">j</span> <span class="op">=</span> <span class="string">"
|
||||
{
|
||||
\"fingerprint\": \"0xF9BA143B95FF6D82\",
|
||||
\"location\": \"Menlo Park, CA\"
|
||||
}"</span>;
|
||||
|
||||
<span class="kw">let</span> <span class="ident">u</span>: <span class="ident">User</span> <span class="op">=</span> <span class="ident">serde_json::from_str</span>(<span class="ident">j</span>).<span class="ident">unwrap</span>();
|
||||
<span class="macro">println!</span>(<span class="string">"{:#?}"</span>, <span class="ident">u</span>);
|
||||
}</code></pre></div>
|
||||
<h2 id="errors"><a href="#errors">Errors</a></h2>
|
||||
<p>This conversion can fail if the structure of the input does not match the
|
||||
structure expected by <code>T</code>, for example if <code>T</code> is a struct type but the input
|
||||
contains something other than a JSON map. It can also fail if the structure
|
||||
is correct but <code>T</code>’s implementation of <code>Deserialize</code> decides that something
|
||||
is wrong with the data, for example required struct fields are missing from
|
||||
the JSON map or some number is too big to fit in the expected primitive
|
||||
type.</p>
|
||||
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="serde_json" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>
|
||||
13
doc/serde_json/de/index.html
Normal file
13
doc/serde_json/de/index.html
Normal file
@ -0,0 +1,13 @@
|
||||
<!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="Deserialize JSON data to a Rust data structure."><meta name="keywords" content="rust, rustlang, rust-lang, de"><title>serde_json::de - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../../serde_json/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../serde_json/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Module de</a></h2><div class="sidebar-elems"><section><div class="block"><ul><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li></ul></div></section></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../serde_json/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Module <a href="../index.html">serde_json</a>::<wbr><a class="mod" href="#">de</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../src/serde_json/de.rs.html#1-2606">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Deserialize JSON data to a Rust data structure.</p>
|
||||
</div></details><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Deserializer.html" title="serde_json::de::Deserializer struct">Deserializer</a></div><div class="item-right docblock-short"><p>A structure that deserializes JSON into Rust values.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.IoRead.html" title="serde_json::de::IoRead struct">IoRead</a></div><div class="item-right docblock-short"><p>JSON input source that reads from a std::io input stream.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.SliceRead.html" title="serde_json::de::SliceRead struct">SliceRead</a></div><div class="item-right docblock-short"><p>JSON input source that reads from a slice of bytes.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.StrRead.html" title="serde_json::de::StrRead struct">StrRead</a></div><div class="item-right docblock-short"><p>JSON input source that reads from a UTF-8 string.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.StreamDeserializer.html" title="serde_json::de::StreamDeserializer struct">StreamDeserializer</a></div><div class="item-right docblock-short"><p>Iterator that deserializes a stream into multiple JSON values.</p>
|
||||
</div></div></div><h2 id="traits" class="small-section-header"><a href="#traits">Traits</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.Read.html" title="serde_json::de::Read trait">Read</a></div><div class="item-right docblock-short"><p>Trait used by the deserializer for iterating over input. This is manually
|
||||
“specialized” for iterating over &<a href="https://doc.rust-lang.org/1.64.0/std/primitive.u8.html" title="u8">u8</a>. Once feature(specialization) is
|
||||
stable we can use actual specialization.</p>
|
||||
</div></div></div><h2 id="functions" class="small-section-header"><a href="#functions">Functions</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.from_reader.html" title="serde_json::de::from_reader fn">from_reader</a></div><div class="item-right docblock-short"><p>Deserialize an instance of type <code>T</code> from an IO stream of JSON.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.from_slice.html" title="serde_json::de::from_slice fn">from_slice</a></div><div class="item-right docblock-short"><p>Deserialize an instance of type <code>T</code> from bytes of JSON text.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.from_str.html" title="serde_json::de::from_str fn">from_str</a></div><div class="item-right docblock-short"><p>Deserialize an instance of type <code>T</code> from a string of JSON text.</p>
|
||||
</div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="serde_json" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>
|
||||
1
doc/serde_json/de/sidebar-items.js
Normal file
1
doc/serde_json/de/sidebar-items.js
Normal file
@ -0,0 +1 @@
|
||||
window.SIDEBAR_ITEMS = {"fn":[["from_reader","Deserialize an instance of type `T` from an IO stream of JSON."],["from_slice","Deserialize an instance of type `T` from bytes of JSON text."],["from_str","Deserialize an instance of type `T` from a string of JSON text."]],"struct":[["Deserializer","A structure that deserializes JSON into Rust values."],["IoRead","JSON input source that reads from a std::io input stream."],["SliceRead","JSON input source that reads from a slice of bytes."],["StrRead","JSON input source that reads from a UTF-8 string."],["StreamDeserializer","Iterator that deserializes a stream into multiple JSON values."]],"trait":[["Read","Trait used by the deserializer for iterating over input. This is manually “specialized” for iterating over &[u8]. Once feature(specialization) is stable we can use actual specialization."]]};
|
||||
133
doc/serde_json/de/struct.Deserializer.html
Normal file
133
doc/serde_json/de/struct.Deserializer.html
Normal file
File diff suppressed because one or more lines are too long
14
doc/serde_json/de/struct.IoRead.html
Normal file
14
doc/serde_json/de/struct.IoRead.html
Normal file
File diff suppressed because one or more lines are too long
14
doc/serde_json/de/struct.SliceRead.html
Normal file
14
doc/serde_json/de/struct.SliceRead.html
Normal file
File diff suppressed because one or more lines are too long
14
doc/serde_json/de/struct.StrRead.html
Normal file
14
doc/serde_json/de/struct.StrRead.html
Normal file
File diff suppressed because one or more lines are too long
178
doc/serde_json/de/struct.StreamDeserializer.html
Normal file
178
doc/serde_json/de/struct.StreamDeserializer.html
Normal file
File diff suppressed because one or more lines are too long
6
doc/serde_json/de/trait.Read.html
Normal file
6
doc/serde_json/de/trait.Read.html
Normal file
@ -0,0 +1,6 @@
|
||||
<!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="Trait used by the deserializer for iterating over input. This is manually “specialized” for iterating over &[u8]. Once feature(specialization) is stable we can use actual specialization."><meta name="keywords" content="rust, rustlang, rust-lang, Read"><title>Read in serde_json::de - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../../serde_json/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../serde_json/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Read</a></h2><div class="sidebar-elems"><section><div class="block"><h3 class="sidebar-title"><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul><li><a href="#impl-Read%3C%27de%3E-for-%26%27a%20mut%20R">&'a mut R</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#implementors">Implementors</a></h3></div></section><h2 class="location"><a href="index.html">In serde_json::de</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../serde_json/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Trait <a href="../index.html">serde_json</a>::<wbr><a href="index.html">de</a>::<wbr><a class="trait" href="#">Read</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../src/serde_json/read.rs.html#26-115">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="docblock item-decl"><pre class="rust trait"><code>pub trait Read<'de>: Sealed { }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Trait used by the deserializer for iterating over input. This is manually
|
||||
“specialized” for iterating over &<a href="https://doc.rust-lang.org/1.64.0/std/primitive.u8.html" title="u8">u8</a>. Once feature(specialization) is
|
||||
stable we can use actual specialization.</p>
|
||||
<p>This trait is sealed and cannot be implemented for types outside of
|
||||
<code>serde_json</code>.</p>
|
||||
</div></details><h2 id="foreign-impls" class="small-section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor"></a></h2><section id="impl-Read%3C%27de%3E-for-%26%27a%20mut%20R" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/serde_json/read.rs.html#711-776">source</a></span><a href="#impl-Read%3C%27de%3E-for-%26%27a%20mut%20R" class="anchor"></a><h3 class="code-header in-band">impl<'a, 'de, R> <a class="trait" href="trait.Read.html" title="trait serde_json::de::Read">Read</a><'de> for <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.reference.html">&'a mut </a>R <span class="where fmt-newline">where<br> R: <a class="trait" href="trait.Read.html" title="trait serde_json::de::Read">Read</a><'de>, </span></h3></section><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"><section id="impl-Read%3C%27a%3E-for-SliceRead%3C%27a%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/serde_json/read.rs.html#487-613">source</a></span><a href="#impl-Read%3C%27a%3E-for-SliceRead%3C%27a%3E" class="anchor"></a><h3 class="code-header in-band">impl<'a> <a class="trait" href="trait.Read.html" title="trait serde_json::de::Read">Read</a><'a> for <a class="struct" href="struct.SliceRead.html" title="struct serde_json::de::SliceRead">SliceRead</a><'a></h3></section><section id="impl-Read%3C%27a%3E-for-StrRead%3C%27a%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/serde_json/read.rs.html#630-705">source</a></span><a href="#impl-Read%3C%27a%3E-for-StrRead%3C%27a%3E" class="anchor"></a><h3 class="code-header in-band">impl<'a> <a class="trait" href="trait.Read.html" title="trait serde_json::de::Read">Read</a><'a> for <a class="struct" href="struct.StrRead.html" title="struct serde_json::de::StrRead">StrRead</a><'a></h3></section><section id="impl-Read%3C%27de%3E-for-IoRead%3CR%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/serde_json/read.rs.html#245-400">source</a></span><a href="#impl-Read%3C%27de%3E-for-IoRead%3CR%3E" class="anchor"></a><h3 class="code-header in-band">impl<'de, R> <a class="trait" href="trait.Read.html" title="trait serde_json::de::Read">Read</a><'de> for <a class="struct" href="struct.IoRead.html" title="struct serde_json::de::IoRead">IoRead</a><R> <span class="where fmt-newline">where<br> R: <a class="trait" href="https://doc.rust-lang.org/1.64.0/std/io/trait.Read.html" title="trait std::io::Read">Read</a>, </span></h3></section></div><script type="text/javascript" src="../../implementors/serde_json/read/trait.Read.js" data-ignore-extern-crates="" async></script></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="serde_json" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>
|
||||
819
doc/serde_json/enum.Value.html
Normal file
819
doc/serde_json/enum.Value.html
Normal file
File diff suppressed because one or more lines are too long
36
doc/serde_json/error/enum.Category.html
Normal file
36
doc/serde_json/error/enum.Category.html
Normal file
File diff suppressed because one or more lines are too long
6
doc/serde_json/error/index.html
Normal file
6
doc/serde_json/error/index.html
Normal file
@ -0,0 +1,6 @@
|
||||
<!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="When serializing or deserializing JSON goes wrong."><meta name="keywords" content="rust, rustlang, rust-lang, error"><title>serde_json::error - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../../serde_json/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../serde_json/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Module error</a></h2><div class="sidebar-elems"><section><div class="block"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#types">Type Definitions</a></li></ul></div></section></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../serde_json/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Module <a href="../index.html">serde_json</a>::<wbr><a class="mod" href="#">error</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../src/serde_json/error.rs.html#1-445">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>When serializing or deserializing JSON goes wrong.</p>
|
||||
</div></details><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Error.html" title="serde_json::error::Error struct">Error</a></div><div class="item-right docblock-short"><p>This type represents all possible errors that can occur when serializing or
|
||||
deserializing JSON data.</p>
|
||||
</div></div></div><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.Category.html" title="serde_json::error::Category enum">Category</a></div><div class="item-right docblock-short"><p>Categorizes the cause of a <code>serde_json::Error</code>.</p>
|
||||
</div></div></div><h2 id="types" class="small-section-header"><a href="#types">Type Definitions</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="type" href="type.Result.html" title="serde_json::error::Result type">Result</a></div><div class="item-right docblock-short"><p>Alias for a <code>Result</code> with the error type <code>serde_json::Error</code>.</p>
|
||||
</div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="serde_json" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>
|
||||
1
doc/serde_json/error/sidebar-items.js
Normal file
1
doc/serde_json/error/sidebar-items.js
Normal file
@ -0,0 +1 @@
|
||||
window.SIDEBAR_ITEMS = {"enum":[["Category","Categorizes the cause of a `serde_json::Error`."]],"struct":[["Error","This type represents all possible errors that can occur when serializing or deserializing JSON data."]],"type":[["Result","Alias for a `Result` with the error type `serde_json::Error`."]]};
|
||||
92
doc/serde_json/error/struct.Error.html
Normal file
92
doc/serde_json/error/struct.Error.html
Normal file
File diff suppressed because one or more lines are too long
2
doc/serde_json/error/type.Result.html
Normal file
2
doc/serde_json/error/type.Result.html
Normal file
@ -0,0 +1,2 @@
|
||||
<!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="Alias for a `Result` with the error type `serde_json::Error`."><meta name="keywords" content="rust, rustlang, rust-lang, Result"><title>Result in serde_json::error - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc type"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../../serde_json/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../serde_json/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Result</a></h2><div class="sidebar-elems"><h2 class="location"><a href="index.html">In serde_json::error</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../serde_json/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Type Definition <a href="../index.html">serde_json</a>::<wbr><a href="index.html">error</a>::<wbr><a class="type" href="#">Result</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../src/serde_json/error.rs.html#23">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="docblock item-decl"><pre class="rust typedef"><code>pub type Result<T> = <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <a class="struct" href="../struct.Error.html" title="struct serde_json::Error">Error</a>>;</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Alias for a <code>Result</code> with the error type <code>serde_json::Error</code>.</p>
|
||||
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="serde_json" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>
|
||||
81
doc/serde_json/fn.from_reader.html
Normal file
81
doc/serde_json/fn.from_reader.html
Normal file
@ -0,0 +1,81 @@
|
||||
<!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="Deserialize an instance of type `T` from an IO stream of JSON."><meta name="keywords" content="rust, rustlang, rust-lang, from_reader"><title>from_reader in serde_json - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><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="../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../dark.css" disabled><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../main.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../serde_json/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../serde_json/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In serde_json</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../serde_json/index.html"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Function <a href="index.html">serde_json</a>::<wbr><a class="fn" href="#">from_reader</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../src/serde_json/de.rs.html#2516-2522">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub fn from_reader<R, T>(rdr: R) -> <a class="type" href="type.Result.html" title="type serde_json::Result">Result</a><T> <span class="where fmt-newline">where<br> R: <a class="trait" href="https://doc.rust-lang.org/1.64.0/std/io/trait.Read.html" title="trait std::io::Read">Read</a>,<br> T: <a class="trait" href="../serde/de/trait.DeserializeOwned.html" title="trait serde::de::DeserializeOwned">DeserializeOwned</a>, </span></code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Deserialize an instance of type <code>T</code> from an IO stream of JSON.</p>
|
||||
<p>The content of the IO stream is deserialized directly from the stream
|
||||
without being buffered in memory by serde_json.</p>
|
||||
<p>When reading from a source against which short reads are not efficient, such
|
||||
as a <a href="https://doc.rust-lang.org/std/fs/struct.File.html"><code>File</code></a>, you will want to apply your own buffering because serde_json
|
||||
will not buffer the input. See <a href="https://doc.rust-lang.org/std/io/struct.BufReader.html"><code>std::io::BufReader</code></a>.</p>
|
||||
<p>It is expected that the input stream ends after the deserialized object.
|
||||
If the stream does not end, such as in the case of a persistent socket connection,
|
||||
this function will not return. It is possible instead to deserialize from a prefix of an input
|
||||
stream without looking for EOF by managing your own <a href="struct.Deserializer.html" title="Deserializer"><code>Deserializer</code></a>.</p>
|
||||
<p>Note that counter to intuition, this function is usually slower than
|
||||
reading a file completely into memory and then applying <a href="./fn.from_str.html"><code>from_str</code></a>
|
||||
or <a href="./fn.from_slice.html"><code>from_slice</code></a> on it. See <a href="https://github.com/serde-rs/json/issues/160">issue #160</a>.</p>
|
||||
<h2 id="example"><a href="#example">Example</a></h2>
|
||||
<p>Reading the contents of a file.</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">serde::Deserialize</span>;
|
||||
|
||||
<span class="kw">use</span> <span class="ident">std::error::Error</span>;
|
||||
<span class="kw">use</span> <span class="ident">std::fs::File</span>;
|
||||
<span class="kw">use</span> <span class="ident">std::io::BufReader</span>;
|
||||
<span class="kw">use</span> <span class="ident">std::path::Path</span>;
|
||||
|
||||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Deserialize</span>, <span class="ident">Debug</span>)]</span>
|
||||
<span class="kw">struct</span> <span class="ident">User</span> {
|
||||
<span class="ident">fingerprint</span>: <span class="ident">String</span>,
|
||||
<span class="ident">location</span>: <span class="ident">String</span>,
|
||||
}
|
||||
|
||||
<span class="kw">fn</span> <span class="ident">read_user_from_file</span><span class="op"><</span><span class="ident">P</span>: <span class="ident">AsRef</span><span class="op"><</span><span class="ident">Path</span><span class="op">></span><span class="op">></span>(<span class="ident">path</span>: <span class="ident">P</span>) -> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">User</span>, <span class="ident">Box</span><span class="op"><</span><span class="kw">dyn</span> <span class="ident">Error</span><span class="op">></span><span class="op">></span> {
|
||||
<span class="comment">// Open the file in read-only mode with buffer.</span>
|
||||
<span class="kw">let</span> <span class="ident">file</span> <span class="op">=</span> <span class="ident">File::open</span>(<span class="ident">path</span>)<span class="question-mark">?</span>;
|
||||
<span class="kw">let</span> <span class="ident">reader</span> <span class="op">=</span> <span class="ident">BufReader::new</span>(<span class="ident">file</span>);
|
||||
|
||||
<span class="comment">// Read the JSON contents of the file as an instance of `User`.</span>
|
||||
<span class="kw">let</span> <span class="ident">u</span> <span class="op">=</span> <span class="ident">serde_json::from_reader</span>(<span class="ident">reader</span>)<span class="question-mark">?</span>;
|
||||
|
||||
<span class="comment">// Return the `User`.</span>
|
||||
<span class="prelude-val">Ok</span>(<span class="ident">u</span>)
|
||||
}
|
||||
|
||||
<span class="kw">fn</span> <span class="ident">main</span>() {
|
||||
<span class="kw">let</span> <span class="ident">u</span> <span class="op">=</span> <span class="ident">read_user_from_file</span>(<span class="string">"test.json"</span>).<span class="ident">unwrap</span>();
|
||||
<span class="macro">println!</span>(<span class="string">"{:#?}"</span>, <span class="ident">u</span>);
|
||||
}</code></pre></div>
|
||||
<p>Reading from a persistent socket connection.</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">serde::Deserialize</span>;
|
||||
|
||||
<span class="kw">use</span> <span class="ident">std::error::Error</span>;
|
||||
<span class="kw">use</span> <span class="ident">std::net</span>::{<span class="ident">TcpListener</span>, <span class="ident">TcpStream</span>};
|
||||
|
||||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Deserialize</span>, <span class="ident">Debug</span>)]</span>
|
||||
<span class="kw">struct</span> <span class="ident">User</span> {
|
||||
<span class="ident">fingerprint</span>: <span class="ident">String</span>,
|
||||
<span class="ident">location</span>: <span class="ident">String</span>,
|
||||
}
|
||||
|
||||
<span class="kw">fn</span> <span class="ident">read_user_from_stream</span>(<span class="ident">tcp_stream</span>: <span class="ident">TcpStream</span>) -> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">User</span>, <span class="ident">Box</span><span class="op"><</span><span class="kw">dyn</span> <span class="ident">Error</span><span class="op">></span><span class="op">></span> {
|
||||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">de</span> <span class="op">=</span> <span class="ident">serde_json::Deserializer::from_reader</span>(<span class="ident">tcp_stream</span>);
|
||||
<span class="kw">let</span> <span class="ident">u</span> <span class="op">=</span> <span class="ident">User::deserialize</span>(<span class="kw-2">&mut</span> <span class="ident">de</span>)<span class="question-mark">?</span>;
|
||||
|
||||
<span class="prelude-val">Ok</span>(<span class="ident">u</span>)
|
||||
}
|
||||
|
||||
<span class="kw">fn</span> <span class="ident">main</span>() {
|
||||
<span class="kw">let</span> <span class="ident">listener</span> <span class="op">=</span> <span class="ident">TcpListener::bind</span>(<span class="string">"127.0.0.1:4000"</span>).<span class="ident">unwrap</span>();
|
||||
|
||||
<span class="kw">for</span> <span class="ident">stream</span> <span class="kw">in</span> <span class="ident">listener</span>.<span class="ident">incoming</span>() {
|
||||
<span class="macro">println!</span>(<span class="string">"{:#?}"</span>, <span class="ident">read_user_from_stream</span>(<span class="ident">stream</span>.<span class="ident">unwrap</span>()));
|
||||
}
|
||||
}</code></pre></div>
|
||||
<h2 id="errors"><a href="#errors">Errors</a></h2>
|
||||
<p>This conversion can fail if the structure of the input does not match the
|
||||
structure expected by <code>T</code>, for example if <code>T</code> is a struct type but the input
|
||||
contains something other than a JSON map. It can also fail if the structure
|
||||
is correct but <code>T</code>’s implementation of <code>Deserialize</code> decides that something
|
||||
is wrong with the data, for example required struct fields are missing from
|
||||
the JSON map or some number is too big to fit in the expected primitive
|
||||
type.</p>
|
||||
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="serde_json" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>
|
||||
30
doc/serde_json/fn.from_slice.html
Normal file
30
doc/serde_json/fn.from_slice.html
Normal file
@ -0,0 +1,30 @@
|
||||
<!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="Deserialize an instance of type `T` from bytes of JSON text."><meta name="keywords" content="rust, rustlang, rust-lang, from_slice"><title>from_slice in serde_json - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><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="../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../dark.css" disabled><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../main.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../serde_json/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../serde_json/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In serde_json</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../serde_json/index.html"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Function <a href="index.html">serde_json</a>::<wbr><a class="fn" href="#">from_slice</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../src/serde_json/de.rs.html#2559-2564">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub fn from_slice<'a, T>(v: &'a [<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.u8.html">u8</a>]) -> <a class="type" href="type.Result.html" title="type serde_json::Result">Result</a><T> <span class="where fmt-newline">where<br> T: <a class="trait" href="../serde/de/trait.Deserialize.html" title="trait serde::de::Deserialize">Deserialize</a><'a>, </span></code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Deserialize an instance of type <code>T</code> from bytes of JSON text.</p>
|
||||
<h2 id="example"><a href="#example">Example</a></h2>
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">serde::Deserialize</span>;
|
||||
|
||||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Deserialize</span>, <span class="ident">Debug</span>)]</span>
|
||||
<span class="kw">struct</span> <span class="ident">User</span> {
|
||||
<span class="ident">fingerprint</span>: <span class="ident">String</span>,
|
||||
<span class="ident">location</span>: <span class="ident">String</span>,
|
||||
}
|
||||
|
||||
<span class="kw">fn</span> <span class="ident">main</span>() {
|
||||
<span class="comment">// The type of `j` is `&[u8]`</span>
|
||||
<span class="kw">let</span> <span class="ident">j</span> <span class="op">=</span> <span class="string">b"
|
||||
{
|
||||
\"fingerprint\": \"0xF9BA143B95FF6D82\",
|
||||
\"location\": \"Menlo Park, CA\"
|
||||
}"</span>;
|
||||
|
||||
<span class="kw">let</span> <span class="ident">u</span>: <span class="ident">User</span> <span class="op">=</span> <span class="ident">serde_json::from_slice</span>(<span class="ident">j</span>).<span class="ident">unwrap</span>();
|
||||
<span class="macro">println!</span>(<span class="string">"{:#?}"</span>, <span class="ident">u</span>);
|
||||
}</code></pre></div>
|
||||
<h2 id="errors"><a href="#errors">Errors</a></h2>
|
||||
<p>This conversion can fail if the structure of the input does not match the
|
||||
structure expected by <code>T</code>, for example if <code>T</code> is a struct type but the input
|
||||
contains something other than a JSON map. It can also fail if the structure
|
||||
is correct but <code>T</code>’s implementation of <code>Deserialize</code> decides that something
|
||||
is wrong with the data, for example required struct fields are missing from
|
||||
the JSON map or some number is too big to fit in the expected primitive
|
||||
type.</p>
|
||||
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="serde_json" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>
|
||||
30
doc/serde_json/fn.from_str.html
Normal file
30
doc/serde_json/fn.from_str.html
Normal file
@ -0,0 +1,30 @@
|
||||
<!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="Deserialize an instance of type `T` from a string of JSON text."><meta name="keywords" content="rust, rustlang, rust-lang, from_str"><title>from_str in serde_json - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><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="../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../dark.css" disabled><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../main.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../serde_json/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../serde_json/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In serde_json</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../serde_json/index.html"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Function <a href="index.html">serde_json</a>::<wbr><a class="fn" href="#">from_str</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../src/serde_json/de.rs.html#2601-2606">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub fn from_str<'a, T>(s: &'a <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.str.html">str</a>) -> <a class="type" href="type.Result.html" title="type serde_json::Result">Result</a><T> <span class="where fmt-newline">where<br> T: <a class="trait" href="../serde/de/trait.Deserialize.html" title="trait serde::de::Deserialize">Deserialize</a><'a>, </span></code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Deserialize an instance of type <code>T</code> from a string of JSON text.</p>
|
||||
<h2 id="example"><a href="#example">Example</a></h2>
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">serde::Deserialize</span>;
|
||||
|
||||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Deserialize</span>, <span class="ident">Debug</span>)]</span>
|
||||
<span class="kw">struct</span> <span class="ident">User</span> {
|
||||
<span class="ident">fingerprint</span>: <span class="ident">String</span>,
|
||||
<span class="ident">location</span>: <span class="ident">String</span>,
|
||||
}
|
||||
|
||||
<span class="kw">fn</span> <span class="ident">main</span>() {
|
||||
<span class="comment">// The type of `j` is `&str`</span>
|
||||
<span class="kw">let</span> <span class="ident">j</span> <span class="op">=</span> <span class="string">"
|
||||
{
|
||||
\"fingerprint\": \"0xF9BA143B95FF6D82\",
|
||||
\"location\": \"Menlo Park, CA\"
|
||||
}"</span>;
|
||||
|
||||
<span class="kw">let</span> <span class="ident">u</span>: <span class="ident">User</span> <span class="op">=</span> <span class="ident">serde_json::from_str</span>(<span class="ident">j</span>).<span class="ident">unwrap</span>();
|
||||
<span class="macro">println!</span>(<span class="string">"{:#?}"</span>, <span class="ident">u</span>);
|
||||
}</code></pre></div>
|
||||
<h2 id="errors"><a href="#errors">Errors</a></h2>
|
||||
<p>This conversion can fail if the structure of the input does not match the
|
||||
structure expected by <code>T</code>, for example if <code>T</code> is a struct type but the input
|
||||
contains something other than a JSON map. It can also fail if the structure
|
||||
is correct but <code>T</code>’s implementation of <code>Deserialize</code> decides that something
|
||||
is wrong with the data, for example required struct fields are missing from
|
||||
the JSON map or some number is too big to fit in the expected primitive
|
||||
type.</p>
|
||||
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="serde_json" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>
|
||||
30
doc/serde_json/fn.from_value.html
Normal file
30
doc/serde_json/fn.from_value.html
Normal file
@ -0,0 +1,30 @@
|
||||
<!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="Interpret a `serde_json::Value` as an instance of type `T`."><meta name="keywords" content="rust, rustlang, rust-lang, from_value"><title>from_value in serde_json - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><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="../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../dark.css" disabled><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../main.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../serde_json/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../serde_json/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In serde_json</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../serde_json/index.html"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Function <a href="index.html">serde_json</a>::<wbr><a class="fn" href="#">from_value</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../src/serde_json/value/mod.rs.html#982-987">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub fn from_value<T>(value: <a class="enum" href="enum.Value.html" title="enum serde_json::Value">Value</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <a class="struct" href="struct.Error.html" title="struct serde_json::Error">Error</a>> <span class="where fmt-newline">where<br> T: <a class="trait" href="../serde/de/trait.DeserializeOwned.html" title="trait serde::de::DeserializeOwned">DeserializeOwned</a>, </span></code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Interpret a <code>serde_json::Value</code> as an instance of type <code>T</code>.</p>
|
||||
<h2 id="example"><a href="#example">Example</a></h2>
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">serde::Deserialize</span>;
|
||||
<span class="kw">use</span> <span class="ident">serde_json::json</span>;
|
||||
|
||||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Deserialize</span>, <span class="ident">Debug</span>)]</span>
|
||||
<span class="kw">struct</span> <span class="ident">User</span> {
|
||||
<span class="ident">fingerprint</span>: <span class="ident">String</span>,
|
||||
<span class="ident">location</span>: <span class="ident">String</span>,
|
||||
}
|
||||
|
||||
<span class="kw">fn</span> <span class="ident">main</span>() {
|
||||
<span class="comment">// The type of `j` is `serde_json::Value`</span>
|
||||
<span class="kw">let</span> <span class="ident">j</span> <span class="op">=</span> <span class="macro">json!</span>({
|
||||
<span class="string">"fingerprint"</span>: <span class="string">"0xF9BA143B95FF6D82"</span>,
|
||||
<span class="string">"location"</span>: <span class="string">"Menlo Park, CA"</span>
|
||||
});
|
||||
|
||||
<span class="kw">let</span> <span class="ident">u</span>: <span class="ident">User</span> <span class="op">=</span> <span class="ident">serde_json::from_value</span>(<span class="ident">j</span>).<span class="ident">unwrap</span>();
|
||||
<span class="macro">println!</span>(<span class="string">"{:#?}"</span>, <span class="ident">u</span>);
|
||||
}</code></pre></div>
|
||||
<h2 id="errors"><a href="#errors">Errors</a></h2>
|
||||
<p>This conversion can fail if the structure of the Value does not match the
|
||||
structure expected by <code>T</code>, for example if <code>T</code> is a struct type but the Value
|
||||
contains something other than a JSON map. It can also fail if the structure
|
||||
is correct but <code>T</code>’s implementation of <code>Deserialize</code> decides that something
|
||||
is wrong with the data, for example required struct fields are missing from
|
||||
the JSON map or some number is too big to fit in the expected primitive
|
||||
type.</p>
|
||||
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="serde_json" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>
|
||||
5
doc/serde_json/fn.to_string.html
Normal file
5
doc/serde_json/fn.to_string.html
Normal file
@ -0,0 +1,5 @@
|
||||
<!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="Serialize the given data structure as a String of JSON."><meta name="keywords" content="rust, rustlang, rust-lang, to_string"><title>to_string in serde_json - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><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="../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../dark.css" disabled><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../main.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../serde_json/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../serde_json/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In serde_json</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../serde_json/index.html"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Function <a href="index.html">serde_json</a>::<wbr><a class="fn" href="#">to_string</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../src/serde_json/ser.rs.html#2139-2149">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub fn to_string<T>(value: <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.reference.html">&</a>T) -> <a class="type" href="type.Result.html" title="type serde_json::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>> <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="../serde/ser/trait.Serialize.html" title="trait serde::ser::Serialize">Serialize</a>, </span></code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Serialize the given data structure as a String of JSON.</p>
|
||||
<h2 id="errors"><a href="#errors">Errors</a></h2>
|
||||
<p>Serialization can fail if <code>T</code>’s implementation of <code>Serialize</code> decides to
|
||||
fail, or if <code>T</code> contains a map with non-string keys.</p>
|
||||
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="serde_json" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>
|
||||
5
doc/serde_json/fn.to_string_pretty.html
Normal file
5
doc/serde_json/fn.to_string_pretty.html
Normal file
@ -0,0 +1,5 @@
|
||||
<!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="Serialize the given data structure as a pretty-printed String of JSON."><meta name="keywords" content="rust, rustlang, rust-lang, to_string_pretty"><title>to_string_pretty in serde_json - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><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="../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../dark.css" disabled><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../main.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../serde_json/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../serde_json/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In serde_json</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../serde_json/index.html"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Function <a href="index.html">serde_json</a>::<wbr><a class="fn" href="#">to_string_pretty</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../src/serde_json/ser.rs.html#2158-2168">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub fn to_string_pretty<T>(value: <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.reference.html">&</a>T) -> <a class="type" href="type.Result.html" title="type serde_json::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>> <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="../serde/ser/trait.Serialize.html" title="trait serde::ser::Serialize">Serialize</a>, </span></code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Serialize the given data structure as a pretty-printed String of JSON.</p>
|
||||
<h2 id="errors"><a href="#errors">Errors</a></h2>
|
||||
<p>Serialization can fail if <code>T</code>’s implementation of <code>Serialize</code> decides to
|
||||
fail, or if <code>T</code> contains a map with non-string keys.</p>
|
||||
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="serde_json" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>
|
||||
45
doc/serde_json/fn.to_value.html
Normal file
45
doc/serde_json/fn.to_value.html
Normal file
@ -0,0 +1,45 @@
|
||||
<!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="Convert a `T` into `serde_json::Value` which is an enum that can represent any valid JSON data."><meta name="keywords" content="rust, rustlang, rust-lang, to_value"><title>to_value in serde_json - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><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="../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../dark.css" disabled><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../main.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../serde_json/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../serde_json/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In serde_json</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../serde_json/index.html"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Function <a href="index.html">serde_json</a>::<wbr><a class="fn" href="#">to_value</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../src/serde_json/value/mod.rs.html#940-945">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub fn to_value<T>(value: T) -> <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="enum" href="enum.Value.html" title="enum serde_json::Value">Value</a>, <a class="struct" href="struct.Error.html" title="struct serde_json::Error">Error</a>> <span class="where fmt-newline">where<br> T: <a class="trait" href="../serde/ser/trait.Serialize.html" title="trait serde::ser::Serialize">Serialize</a>, </span></code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Convert a <code>T</code> into <code>serde_json::Value</code> which is an enum that can represent
|
||||
any valid JSON data.</p>
|
||||
<h2 id="example"><a href="#example">Example</a></h2>
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">serde::Serialize</span>;
|
||||
<span class="kw">use</span> <span class="ident">serde_json::json</span>;
|
||||
|
||||
<span class="kw">use</span> <span class="ident">std::error::Error</span>;
|
||||
|
||||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Serialize</span>)]</span>
|
||||
<span class="kw">struct</span> <span class="ident">User</span> {
|
||||
<span class="ident">fingerprint</span>: <span class="ident">String</span>,
|
||||
<span class="ident">location</span>: <span class="ident">String</span>,
|
||||
}
|
||||
|
||||
<span class="kw">fn</span> <span class="ident">compare_json_values</span>() -> <span class="prelude-ty">Result</span><span class="op"><</span>(), <span class="ident">Box</span><span class="op"><</span><span class="ident">Error</span><span class="op">></span><span class="op">></span> {
|
||||
<span class="kw">let</span> <span class="ident">u</span> <span class="op">=</span> <span class="ident">User</span> {
|
||||
<span class="ident">fingerprint</span>: <span class="string">"0xF9BA143B95FF6D82"</span>.<span class="ident">to_owned</span>(),
|
||||
<span class="ident">location</span>: <span class="string">"Menlo Park, CA"</span>.<span class="ident">to_owned</span>(),
|
||||
};
|
||||
|
||||
<span class="comment">// The type of `expected` is `serde_json::Value`</span>
|
||||
<span class="kw">let</span> <span class="ident">expected</span> <span class="op">=</span> <span class="macro">json!</span>({
|
||||
<span class="string">"fingerprint"</span>: <span class="string">"0xF9BA143B95FF6D82"</span>,
|
||||
<span class="string">"location"</span>: <span class="string">"Menlo Park, CA"</span>,
|
||||
});
|
||||
|
||||
<span class="kw">let</span> <span class="ident">v</span> <span class="op">=</span> <span class="ident">serde_json::to_value</span>(<span class="ident">u</span>).<span class="ident">unwrap</span>();
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">v</span>, <span class="ident">expected</span>);
|
||||
|
||||
<span class="prelude-val">Ok</span>(())
|
||||
}</code></pre></div>
|
||||
<h2 id="errors"><a href="#errors">Errors</a></h2>
|
||||
<p>This conversion can fail if <code>T</code>’s implementation of <code>Serialize</code> decides to
|
||||
fail, or if <code>T</code> contains a map with non-string keys.</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">std::collections::BTreeMap</span>;
|
||||
|
||||
<span class="kw">fn</span> <span class="ident">main</span>() {
|
||||
<span class="comment">// The keys in this map are vectors, not strings.</span>
|
||||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">map</span> <span class="op">=</span> <span class="ident">BTreeMap::new</span>();
|
||||
<span class="ident">map</span>.<span class="ident">insert</span>(<span class="macro">vec!</span>[<span class="number">32</span>, <span class="number">64</span>], <span class="string">"x86"</span>);
|
||||
|
||||
<span class="macro">println!</span>(<span class="string">"{}"</span>, <span class="ident">serde_json::to_value</span>(<span class="ident">map</span>).<span class="ident">unwrap_err</span>());
|
||||
}</code></pre></div>
|
||||
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="serde_json" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>
|
||||
5
doc/serde_json/fn.to_vec.html
Normal file
5
doc/serde_json/fn.to_vec.html
Normal file
@ -0,0 +1,5 @@
|
||||
<!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="Serialize the given data structure as a JSON byte vector."><meta name="keywords" content="rust, rustlang, rust-lang, to_vec"><title>to_vec in serde_json - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><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="../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../dark.css" disabled><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../main.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../serde_json/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../serde_json/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In serde_json</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../serde_json/index.html"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Function <a href="index.html">serde_json</a>::<wbr><a class="fn" href="#">to_vec</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../src/serde_json/ser.rs.html#2107-2114">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub fn to_vec<T>(value: <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.reference.html">&</a>T) -> <a class="type" href="type.Result.html" title="type serde_json::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.u8.html">u8</a>>> <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="../serde/ser/trait.Serialize.html" title="trait serde::ser::Serialize">Serialize</a>, </span></code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Serialize the given data structure as a JSON byte vector.</p>
|
||||
<h2 id="errors"><a href="#errors">Errors</a></h2>
|
||||
<p>Serialization can fail if <code>T</code>’s implementation of <code>Serialize</code> decides to
|
||||
fail, or if <code>T</code> contains a map with non-string keys.</p>
|
||||
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="serde_json" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>
|
||||
5
doc/serde_json/fn.to_vec_pretty.html
Normal file
5
doc/serde_json/fn.to_vec_pretty.html
Normal file
@ -0,0 +1,5 @@
|
||||
<!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="Serialize the given data structure as a pretty-printed JSON byte vector."><meta name="keywords" content="rust, rustlang, rust-lang, to_vec_pretty"><title>to_vec_pretty in serde_json - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><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="../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../dark.css" disabled><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../main.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../serde_json/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../serde_json/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In serde_json</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../serde_json/index.html"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Function <a href="index.html">serde_json</a>::<wbr><a class="fn" href="#">to_vec_pretty</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../src/serde_json/ser.rs.html#2123-2130">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub fn to_vec_pretty<T>(value: <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.reference.html">&</a>T) -> <a class="type" href="type.Result.html" title="type serde_json::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.u8.html">u8</a>>> <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="../serde/ser/trait.Serialize.html" title="trait serde::ser::Serialize">Serialize</a>, </span></code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Serialize the given data structure as a pretty-printed JSON byte vector.</p>
|
||||
<h2 id="errors"><a href="#errors">Errors</a></h2>
|
||||
<p>Serialization can fail if <code>T</code>’s implementation of <code>Serialize</code> decides to
|
||||
fail, or if <code>T</code> contains a map with non-string keys.</p>
|
||||
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="serde_json" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>
|
||||
5
doc/serde_json/fn.to_writer.html
Normal file
5
doc/serde_json/fn.to_writer.html
Normal file
@ -0,0 +1,5 @@
|
||||
<!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="Serialize the given data structure as JSON into the IO stream."><meta name="keywords" content="rust, rustlang, rust-lang, to_writer"><title>to_writer in serde_json - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><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="../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../dark.css" disabled><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../main.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../serde_json/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../serde_json/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In serde_json</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../serde_json/index.html"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Function <a href="index.html">serde_json</a>::<wbr><a class="fn" href="#">to_writer</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../src/serde_json/ser.rs.html#2073-2080">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub fn to_writer<W, T>(writer: W, value: <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.reference.html">&</a>T) -> <a class="type" href="type.Result.html" title="type serde_json::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.unit.html">()</a>> <span class="where fmt-newline">where<br> W: <a class="trait" href="https://doc.rust-lang.org/1.64.0/std/io/trait.Write.html" title="trait std::io::Write">Write</a>,<br> T: ?<a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="../serde/ser/trait.Serialize.html" title="trait serde::ser::Serialize">Serialize</a>, </span></code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Serialize the given data structure as JSON into the IO stream.</p>
|
||||
<h2 id="errors"><a href="#errors">Errors</a></h2>
|
||||
<p>Serialization can fail if <code>T</code>’s implementation of <code>Serialize</code> decides to
|
||||
fail, or if <code>T</code> contains a map with non-string keys.</p>
|
||||
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="serde_json" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>
|
||||
6
doc/serde_json/fn.to_writer_pretty.html
Normal file
6
doc/serde_json/fn.to_writer_pretty.html
Normal file
@ -0,0 +1,6 @@
|
||||
<!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="Serialize the given data structure as pretty-printed JSON into the IO stream."><meta name="keywords" content="rust, rustlang, rust-lang, to_writer_pretty"><title>to_writer_pretty in serde_json - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><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="../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../dark.css" disabled><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../main.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../serde_json/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../serde_json/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In serde_json</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../serde_json/index.html"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Function <a href="index.html">serde_json</a>::<wbr><a class="fn" href="#">to_writer_pretty</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../src/serde_json/ser.rs.html#2091-2098">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub fn to_writer_pretty<W, T>(writer: W, value: <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.reference.html">&</a>T) -> <a class="type" href="type.Result.html" title="type serde_json::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.unit.html">()</a>> <span class="where fmt-newline">where<br> W: <a class="trait" href="https://doc.rust-lang.org/1.64.0/std/io/trait.Write.html" title="trait std::io::Write">Write</a>,<br> T: ?<a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="../serde/ser/trait.Serialize.html" title="trait serde::ser::Serialize">Serialize</a>, </span></code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Serialize the given data structure as pretty-printed JSON into the IO
|
||||
stream.</p>
|
||||
<h2 id="errors"><a href="#errors">Errors</a></h2>
|
||||
<p>Serialization can fail if <code>T</code>’s implementation of <code>Serialize</code> decides to
|
||||
fail, or if <code>T</code> contains a map with non-string keys.</p>
|
||||
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="serde_json" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>
|
||||
256
doc/serde_json/index.html
Normal file
256
doc/serde_json/index.html
Normal file
@ -0,0 +1,256 @@
|
||||
<!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="Serde JSON"><meta name="keywords" content="rust, rustlang, rust-lang, serde_json"><title>serde_json - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><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="../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../dark.css" disabled><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer src="../crates.js"></script><script defer src="../main.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></head><body class="rustdoc mod crate"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../serde_json/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../serde_json/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Crate serde_json</a></h2><div class="sidebar-elems"><div class="block"><ul><li class="version">Version 1.0.91</li><li><a id="all-types" href="all.html">All Items</a></li></ul></div><section><div class="block"><ul><li><a href="#modules">Modules</a></li><li><a href="#macros">Macros</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#functions">Functions</a></li><li><a href="#types">Type Definitions</a></li></ul></div></section></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../serde_json/index.html"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Crate <a class="mod" href="#">serde_json</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../src/serde_json/lib.rs.html#1-421">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><h2 id="serde-json"><a href="#serde-json">Serde JSON</a></h2>
|
||||
<p>JSON is a ubiquitous open-standard format that uses human-readable text to
|
||||
transmit data objects consisting of key-value pairs.</p>
|
||||
<div class="example-wrap"><pre class="language-json"><code>{
|
||||
"name": "John Doe",
|
||||
"age": 43,
|
||||
"address": {
|
||||
"street": "10 Downing Street",
|
||||
"city": "London"
|
||||
},
|
||||
"phones": [
|
||||
"+44 1234567",
|
||||
"+44 2345678"
|
||||
]
|
||||
}</code></pre></div>
|
||||
<p>There are three common ways that you might find yourself needing to work
|
||||
with JSON data in Rust.</p>
|
||||
<ul>
|
||||
<li><strong>As text data.</strong> An unprocessed string of JSON data that you receive on
|
||||
an HTTP endpoint, read from a file, or prepare to send to a remote
|
||||
server.</li>
|
||||
<li><strong>As an untyped or loosely typed representation.</strong> Maybe you want to
|
||||
check that some JSON data is valid before passing it on, but without
|
||||
knowing the structure of what it contains. Or you want to do very basic
|
||||
manipulations like insert a key in a particular spot.</li>
|
||||
<li><strong>As a strongly typed Rust data structure.</strong> When you expect all or most
|
||||
of your data to conform to a particular structure and want to get real
|
||||
work done without JSON’s loosey-goosey nature tripping you up.</li>
|
||||
</ul>
|
||||
<p>Serde JSON provides efficient, flexible, safe ways of converting data
|
||||
between each of these representations.</p>
|
||||
<h2 id="operating-on-untyped-json-values"><a href="#operating-on-untyped-json-values">Operating on untyped JSON values</a></h2>
|
||||
<p>Any valid JSON data can be manipulated in the following recursive enum
|
||||
representation. This data structure is <a href="https://docs.serde.rs/serde_json/value/enum.Value.html"><code>serde_json::Value</code></a>.</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">enum</span> <span class="ident">Value</span> {
|
||||
<span class="ident">Null</span>,
|
||||
<span class="ident">Bool</span>(<span class="ident">bool</span>),
|
||||
<span class="ident">Number</span>(<span class="ident">Number</span>),
|
||||
<span class="ident">String</span>(<span class="ident">String</span>),
|
||||
<span class="ident">Array</span>(<span class="ident">Vec</span><span class="op"><</span><span class="ident">Value</span><span class="op">></span>),
|
||||
<span class="ident">Object</span>(<span class="ident">Map</span><span class="op"><</span><span class="ident">String</span>, <span class="ident">Value</span><span class="op">></span>),
|
||||
}</code></pre></div>
|
||||
<p>A string of JSON data can be parsed into a <code>serde_json::Value</code> by the
|
||||
<a href="https://docs.serde.rs/serde_json/de/fn.from_str.html"><code>serde_json::from_str</code></a> function. There is also
|
||||
<a href="https://docs.serde.rs/serde_json/de/fn.from_slice.html"><code>from_slice</code></a> for parsing from a byte slice &<a href="https://doc.rust-lang.org/1.64.0/std/primitive.u8.html" title="u8">u8</a> and
|
||||
<a href="https://docs.serde.rs/serde_json/de/fn.from_reader.html"><code>from_reader</code></a> for parsing from any <code>io::Read</code> like a File or
|
||||
a TCP stream.</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">serde_json</span>::{<span class="prelude-ty">Result</span>, <span class="ident">Value</span>};
|
||||
|
||||
<span class="kw">fn</span> <span class="ident">untyped_example</span>() -> <span class="prelude-ty">Result</span><span class="op"><</span>()<span class="op">></span> {
|
||||
<span class="comment">// Some JSON input data as a &str. Maybe this comes from the user.</span>
|
||||
<span class="kw">let</span> <span class="ident">data</span> <span class="op">=</span> <span class="string">r#"
|
||||
{
|
||||
"name": "John Doe",
|
||||
"age": 43,
|
||||
"phones": [
|
||||
"+44 1234567",
|
||||
"+44 2345678"
|
||||
]
|
||||
}"#</span>;
|
||||
|
||||
<span class="comment">// Parse the string of data into serde_json::Value.</span>
|
||||
<span class="kw">let</span> <span class="ident">v</span>: <span class="ident">Value</span> <span class="op">=</span> <span class="ident">serde_json::from_str</span>(<span class="ident">data</span>)<span class="question-mark">?</span>;
|
||||
|
||||
<span class="comment">// Access parts of the data by indexing with square brackets.</span>
|
||||
<span class="macro">println!</span>(<span class="string">"Please call {} at the number {}"</span>, <span class="ident">v</span>[<span class="string">"name"</span>], <span class="ident">v</span>[<span class="string">"phones"</span>][<span class="number">0</span>]);
|
||||
|
||||
<span class="prelude-val">Ok</span>(())
|
||||
}</code></pre></div>
|
||||
<p>The result of square bracket indexing like <code>v["name"]</code> is a borrow of the
|
||||
data at that index, so the type is <code>&Value</code>. A JSON map can be indexed with
|
||||
string keys, while a JSON array can be indexed with integer keys. If the
|
||||
type of the data is not right for the type with which it is being indexed,
|
||||
or if a map does not contain the key being indexed, or if the index into a
|
||||
vector is out of bounds, the returned element is <code>Value::Null</code>.</p>
|
||||
<p>When a <code>Value</code> is printed, it is printed as a JSON string. So in the code
|
||||
above, the output looks like <code>Please call "John Doe" at the number "+44 1234567"</code>. The quotation marks appear because <code>v["name"]</code> is a <code>&Value</code>
|
||||
containing a JSON string and its JSON representation is <code>"John Doe"</code>.
|
||||
Printing as a plain string without quotation marks involves converting from
|
||||
a JSON string to a Rust string with <a href="https://docs.serde.rs/serde_json/enum.Value.html#method.as_str"><code>as_str()</code></a> or avoiding the use of
|
||||
<code>Value</code> as described in the following section.</p>
|
||||
<p>The <code>Value</code> representation is sufficient for very basic tasks but can be
|
||||
tedious to work with for anything more significant. Error handling is
|
||||
verbose to implement correctly, for example imagine trying to detect the
|
||||
presence of unrecognized fields in the input data. The compiler is powerless
|
||||
to help you when you make a mistake, for example imagine typoing <code>v["name"]</code>
|
||||
as <code>v["nmae"]</code> in one of the dozens of places it is used in your code.</p>
|
||||
<h2 id="parsing-json-as-strongly-typed-data-structures"><a href="#parsing-json-as-strongly-typed-data-structures">Parsing JSON as strongly typed data structures</a></h2>
|
||||
<p>Serde provides a powerful way of mapping JSON data into Rust data structures
|
||||
largely automatically.</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">serde</span>::{<span class="ident">Deserialize</span>, <span class="ident">Serialize</span>};
|
||||
<span class="kw">use</span> <span class="ident">serde_json::Result</span>;
|
||||
|
||||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Serialize</span>, <span class="ident">Deserialize</span>)]</span>
|
||||
<span class="kw">struct</span> <span class="ident">Person</span> {
|
||||
<span class="ident">name</span>: <span class="ident">String</span>,
|
||||
<span class="ident">age</span>: <span class="ident">u8</span>,
|
||||
<span class="ident">phones</span>: <span class="ident">Vec</span><span class="op"><</span><span class="ident">String</span><span class="op">></span>,
|
||||
}
|
||||
|
||||
<span class="kw">fn</span> <span class="ident">typed_example</span>() -> <span class="prelude-ty">Result</span><span class="op"><</span>()<span class="op">></span> {
|
||||
<span class="comment">// Some JSON input data as a &str. Maybe this comes from the user.</span>
|
||||
<span class="kw">let</span> <span class="ident">data</span> <span class="op">=</span> <span class="string">r#"
|
||||
{
|
||||
"name": "John Doe",
|
||||
"age": 43,
|
||||
"phones": [
|
||||
"+44 1234567",
|
||||
"+44 2345678"
|
||||
]
|
||||
}"#</span>;
|
||||
|
||||
<span class="comment">// Parse the string of data into a Person object. This is exactly the</span>
|
||||
<span class="comment">// same function as the one that produced serde_json::Value above, but</span>
|
||||
<span class="comment">// now we are asking it for a Person as output.</span>
|
||||
<span class="kw">let</span> <span class="ident">p</span>: <span class="ident">Person</span> <span class="op">=</span> <span class="ident">serde_json::from_str</span>(<span class="ident">data</span>)<span class="question-mark">?</span>;
|
||||
|
||||
<span class="comment">// Do things just like with any other Rust data structure.</span>
|
||||
<span class="macro">println!</span>(<span class="string">"Please call {} at the number {}"</span>, <span class="ident">p</span>.<span class="ident">name</span>, <span class="ident">p</span>.<span class="ident">phones</span>[<span class="number">0</span>]);
|
||||
|
||||
<span class="prelude-val">Ok</span>(())
|
||||
}</code></pre></div>
|
||||
<p>This is the same <code>serde_json::from_str</code> function as before, but this time we
|
||||
assign the return value to a variable of type <code>Person</code> so Serde will
|
||||
automatically interpret the input data as a <code>Person</code> and produce informative
|
||||
error messages if the layout does not conform to what a <code>Person</code> is expected
|
||||
to look like.</p>
|
||||
<p>Any type that implements Serde’s <code>Deserialize</code> trait can be deserialized
|
||||
this way. This includes built-in Rust standard library types like <code>Vec<T></code>
|
||||
and <code>HashMap<K, V></code>, as well as any structs or enums annotated with
|
||||
<code>#[derive(Deserialize)]</code>.</p>
|
||||
<p>Once we have <code>p</code> of type <code>Person</code>, our IDE and the Rust compiler can help us
|
||||
use it correctly like they do for any other Rust code. The IDE can
|
||||
autocomplete field names to prevent typos, which was impossible in the
|
||||
<code>serde_json::Value</code> representation. And the Rust compiler can check that
|
||||
when we write <code>p.phones[0]</code>, then <code>p.phones</code> is guaranteed to be a
|
||||
<code>Vec<String></code> so indexing into it makes sense and produces a <code>String</code>.</p>
|
||||
<h2 id="constructing-json-values"><a href="#constructing-json-values">Constructing JSON values</a></h2>
|
||||
<p>Serde JSON provides a <a href="https://docs.serde.rs/serde_json/macro.json.html"><code>json!</code> macro</a> to build <code>serde_json::Value</code>
|
||||
objects with very natural JSON syntax.</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">serde_json::json</span>;
|
||||
|
||||
<span class="kw">fn</span> <span class="ident">main</span>() {
|
||||
<span class="comment">// The type of `john` is `serde_json::Value`</span>
|
||||
<span class="kw">let</span> <span class="ident">john</span> <span class="op">=</span> <span class="macro">json!</span>({
|
||||
<span class="string">"name"</span>: <span class="string">"John Doe"</span>,
|
||||
<span class="string">"age"</span>: <span class="number">43</span>,
|
||||
<span class="string">"phones"</span>: [
|
||||
<span class="string">"+44 1234567"</span>,
|
||||
<span class="string">"+44 2345678"</span>
|
||||
]
|
||||
});
|
||||
|
||||
<span class="macro">println!</span>(<span class="string">"first phone number: {}"</span>, <span class="ident">john</span>[<span class="string">"phones"</span>][<span class="number">0</span>]);
|
||||
|
||||
<span class="comment">// Convert to a string of JSON and print it out</span>
|
||||
<span class="macro">println!</span>(<span class="string">"{}"</span>, <span class="ident">john</span>.<span class="ident">to_string</span>());
|
||||
}</code></pre></div>
|
||||
<p>The <code>Value::to_string()</code> function converts a <code>serde_json::Value</code> into a
|
||||
<code>String</code> of JSON text.</p>
|
||||
<p>One neat thing about the <code>json!</code> macro is that variables and expressions can
|
||||
be interpolated directly into the JSON value as you are building it. Serde
|
||||
will check at compile time that the value you are interpolating is able to
|
||||
be represented as JSON.</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">full_name</span> <span class="op">=</span> <span class="string">"John Doe"</span>;
|
||||
<span class="kw">let</span> <span class="ident">age_last_year</span> <span class="op">=</span> <span class="number">42</span>;
|
||||
|
||||
<span class="comment">// The type of `john` is `serde_json::Value`</span>
|
||||
<span class="kw">let</span> <span class="ident">john</span> <span class="op">=</span> <span class="macro">json!</span>({
|
||||
<span class="string">"name"</span>: <span class="ident">full_name</span>,
|
||||
<span class="string">"age"</span>: <span class="ident">age_last_year</span> <span class="op">+</span> <span class="number">1</span>,
|
||||
<span class="string">"phones"</span>: [
|
||||
<span class="macro">format!</span>(<span class="string">"+44 {}"</span>, <span class="ident">random_phone</span>())
|
||||
]
|
||||
});</code></pre></div>
|
||||
<p>This is amazingly convenient, but we have the problem we had before with
|
||||
<code>Value</code>: the IDE and Rust compiler cannot help us if we get it wrong. Serde
|
||||
JSON provides a better way of serializing strongly-typed data structures
|
||||
into JSON text.</p>
|
||||
<h2 id="creating-json-by-serializing-data-structures"><a href="#creating-json-by-serializing-data-structures">Creating JSON by serializing data structures</a></h2>
|
||||
<p>A data structure can be converted to a JSON string by
|
||||
<a href="https://docs.serde.rs/serde_json/ser/fn.to_string.html"><code>serde_json::to_string</code></a>. There is also
|
||||
<a href="https://docs.serde.rs/serde_json/ser/fn.to_vec.html"><code>serde_json::to_vec</code></a> which serializes to a <code>Vec<u8></code> and
|
||||
<a href="https://docs.serde.rs/serde_json/ser/fn.to_writer.html"><code>serde_json::to_writer</code></a> which serializes to any <code>io::Write</code>
|
||||
such as a File or a TCP stream.</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">serde</span>::{<span class="ident">Deserialize</span>, <span class="ident">Serialize</span>};
|
||||
<span class="kw">use</span> <span class="ident">serde_json::Result</span>;
|
||||
|
||||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Serialize</span>, <span class="ident">Deserialize</span>)]</span>
|
||||
<span class="kw">struct</span> <span class="ident">Address</span> {
|
||||
<span class="ident">street</span>: <span class="ident">String</span>,
|
||||
<span class="ident">city</span>: <span class="ident">String</span>,
|
||||
}
|
||||
|
||||
<span class="kw">fn</span> <span class="ident">print_an_address</span>() -> <span class="prelude-ty">Result</span><span class="op"><</span>()<span class="op">></span> {
|
||||
<span class="comment">// Some data structure.</span>
|
||||
<span class="kw">let</span> <span class="ident">address</span> <span class="op">=</span> <span class="ident">Address</span> {
|
||||
<span class="ident">street</span>: <span class="string">"10 Downing Street"</span>.<span class="ident">to_owned</span>(),
|
||||
<span class="ident">city</span>: <span class="string">"London"</span>.<span class="ident">to_owned</span>(),
|
||||
};
|
||||
|
||||
<span class="comment">// Serialize it to a JSON string.</span>
|
||||
<span class="kw">let</span> <span class="ident">j</span> <span class="op">=</span> <span class="ident">serde_json::to_string</span>(<span class="kw-2">&</span><span class="ident">address</span>)<span class="question-mark">?</span>;
|
||||
|
||||
<span class="comment">// Print, write to a file, or send to an HTTP server.</span>
|
||||
<span class="macro">println!</span>(<span class="string">"{}"</span>, <span class="ident">j</span>);
|
||||
|
||||
<span class="prelude-val">Ok</span>(())
|
||||
}</code></pre></div>
|
||||
<p>Any type that implements Serde’s <code>Serialize</code> trait can be serialized this
|
||||
way. This includes built-in Rust standard library types like <code>Vec<T></code> and
|
||||
<code>HashMap<K, V></code>, as well as any structs or enums annotated with
|
||||
<code>#[derive(Serialize)]</code>.</p>
|
||||
<h2 id="no-std-support"><a href="#no-std-support">No-std support</a></h2>
|
||||
<p>As long as there is a memory allocator, it is possible to use serde_json
|
||||
without the rest of the Rust standard library. Disable the default “std”
|
||||
feature and enable the “alloc” feature:</p>
|
||||
<div class="example-wrap"><pre class="language-toml"><code>[dependencies]
|
||||
serde_json = { version = "1.0", default-features = false, features = ["alloc"] }</code></pre></div>
|
||||
<p>For JSON support in Serde without a memory allocator, please see the
|
||||
<a href="https://github.com/rust-embedded-community/serde-json-core"><code>serde-json-core</code></a> crate.</p>
|
||||
</div></details><h2 id="modules" class="small-section-header"><a href="#modules">Modules</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="mod" href="de/index.html" title="serde_json::de mod">de</a></div><div class="item-right docblock-short"><p>Deserialize JSON data to a Rust data structure.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="error/index.html" title="serde_json::error mod">error</a></div><div class="item-right docblock-short"><p>When serializing or deserializing JSON goes wrong.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="map/index.html" title="serde_json::map mod">map</a></div><div class="item-right docblock-short"><p>A map of String to serde_json::Value.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="ser/index.html" title="serde_json::ser mod">ser</a></div><div class="item-right docblock-short"><p>Serialize a Rust data structure into JSON data.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="value/index.html" title="serde_json::value mod">value</a></div><div class="item-right docblock-short"><p>The Value enum, a loosely typed way of representing any valid JSON value.</p>
|
||||
</div></div></div><h2 id="macros" class="small-section-header"><a href="#macros">Macros</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="macro" href="macro.json.html" title="serde_json::json macro">json</a></div><div class="item-right docblock-short"><p>Construct a <code>serde_json::Value</code> from a JSON literal.</p>
|
||||
</div></div></div><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Deserializer.html" title="serde_json::Deserializer struct">Deserializer</a></div><div class="item-right docblock-short"><p>A structure that deserializes JSON into Rust values.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Error.html" title="serde_json::Error struct">Error</a></div><div class="item-right docblock-short"><p>This type represents all possible errors that can occur when serializing or
|
||||
deserializing JSON data.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Map.html" title="serde_json::Map struct">Map</a></div><div class="item-right docblock-short"><p>Represents a JSON key/value type.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Number.html" title="serde_json::Number struct">Number</a></div><div class="item-right docblock-short"><p>Represents a JSON number, whether integer or floating point.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Serializer.html" title="serde_json::Serializer struct">Serializer</a></div><div class="item-right docblock-short"><p>A structure for serializing Rust values into JSON.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.StreamDeserializer.html" title="serde_json::StreamDeserializer struct">StreamDeserializer</a></div><div class="item-right docblock-short"><p>Iterator that deserializes a stream into multiple JSON values.</p>
|
||||
</div></div></div><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.Value.html" title="serde_json::Value enum">Value</a></div><div class="item-right docblock-short"><p>Represents any valid JSON value.</p>
|
||||
</div></div></div><h2 id="functions" class="small-section-header"><a href="#functions">Functions</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.from_reader.html" title="serde_json::from_reader fn">from_reader</a></div><div class="item-right docblock-short"><p>Deserialize an instance of type <code>T</code> from an IO stream of JSON.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.from_slice.html" title="serde_json::from_slice fn">from_slice</a></div><div class="item-right docblock-short"><p>Deserialize an instance of type <code>T</code> from bytes of JSON text.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.from_str.html" title="serde_json::from_str fn">from_str</a></div><div class="item-right docblock-short"><p>Deserialize an instance of type <code>T</code> from a string of JSON text.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.from_value.html" title="serde_json::from_value fn">from_value</a></div><div class="item-right docblock-short"><p>Interpret a <code>serde_json::Value</code> as an instance of type <code>T</code>.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.to_string.html" title="serde_json::to_string fn">to_string</a></div><div class="item-right docblock-short"><p>Serialize the given data structure as a String of JSON.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.to_string_pretty.html" title="serde_json::to_string_pretty fn">to_string_pretty</a></div><div class="item-right docblock-short"><p>Serialize the given data structure as a pretty-printed String of JSON.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.to_value.html" title="serde_json::to_value fn">to_value</a></div><div class="item-right docblock-short"><p>Convert a <code>T</code> into <code>serde_json::Value</code> which is an enum that can represent
|
||||
any valid JSON data.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.to_vec.html" title="serde_json::to_vec fn">to_vec</a></div><div class="item-right docblock-short"><p>Serialize the given data structure as a JSON byte vector.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.to_vec_pretty.html" title="serde_json::to_vec_pretty fn">to_vec_pretty</a></div><div class="item-right docblock-short"><p>Serialize the given data structure as a pretty-printed JSON byte vector.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.to_writer.html" title="serde_json::to_writer fn">to_writer</a></div><div class="item-right docblock-short"><p>Serialize the given data structure as JSON into the IO stream.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.to_writer_pretty.html" title="serde_json::to_writer_pretty fn">to_writer_pretty</a></div><div class="item-right docblock-short"><p>Serialize the given data structure as pretty-printed JSON into the IO
|
||||
stream.</p>
|
||||
</div></div></div><h2 id="types" class="small-section-header"><a href="#types">Type Definitions</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="type" href="type.Result.html" title="serde_json::Result type">Result</a></div><div class="item-right docblock-short"><p>Alias for a <code>Result</code> with the error type <code>serde_json::Error</code>.</p>
|
||||
</div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="serde_json" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>
|
||||
11
doc/serde_json/macro.json!.html
Normal file
11
doc/serde_json/macro.json!.html
Normal file
@ -0,0 +1,11 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=macro.json.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="macro.json.html">macro.json.html</a>...</p>
|
||||
<script>location.replace("macro.json.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
41
doc/serde_json/macro.json.html
Normal file
41
doc/serde_json/macro.json.html
Normal file
@ -0,0 +1,41 @@
|
||||
<!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="Construct a `serde_json::Value` from a JSON literal."><meta name="keywords" content="rust, rustlang, rust-lang, json"><title>json in serde_json - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><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="../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../dark.css" disabled><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../main.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></head><body class="rustdoc macro"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../serde_json/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../serde_json/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In serde_json</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../serde_json/index.html"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Macro <a href="index.html">serde_json</a>::<wbr><a class="macro" href="#">json</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../src/serde_json/macros.rs.html#53-58">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="docblock item-decl"><div class="example-wrap"><pre class="rust macro"><code><span class="macro">macro_rules!</span> <span class="ident">json</span> {
|
||||
($(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">json</span>:<span class="ident">tt</span>)<span class="op">+</span>) => { ... };
|
||||
}</code></pre></div>
|
||||
</div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Construct a <code>serde_json::Value</code> from a JSON literal.</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">value</span> <span class="op">=</span> <span class="macro">json!</span>({
|
||||
<span class="string">"code"</span>: <span class="number">200</span>,
|
||||
<span class="string">"success"</span>: <span class="bool-val">true</span>,
|
||||
<span class="string">"payload"</span>: {
|
||||
<span class="string">"features"</span>: [
|
||||
<span class="string">"serde"</span>,
|
||||
<span class="string">"json"</span>
|
||||
]
|
||||
}
|
||||
});</code></pre></div>
|
||||
<p>Variables or expressions can be interpolated into the JSON literal. Any type
|
||||
interpolated into an array element or object value must implement Serde’s
|
||||
<code>Serialize</code> trait, while any type interpolated into a object key must
|
||||
implement <code>Into<String></code>. If the <code>Serialize</code> implementation of the
|
||||
interpolated type decides to fail, or if the interpolated type contains a
|
||||
map with non-string keys, the <code>json!</code> macro will panic.</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">code</span> <span class="op">=</span> <span class="number">200</span>;
|
||||
<span class="kw">let</span> <span class="ident">features</span> <span class="op">=</span> <span class="macro">vec!</span>[<span class="string">"serde"</span>, <span class="string">"json"</span>];
|
||||
|
||||
<span class="kw">let</span> <span class="ident">value</span> <span class="op">=</span> <span class="macro">json!</span>({
|
||||
<span class="string">"code"</span>: <span class="ident">code</span>,
|
||||
<span class="string">"success"</span>: <span class="ident">code</span> <span class="op">==</span> <span class="number">200</span>,
|
||||
<span class="string">"payload"</span>: {
|
||||
<span class="ident">features</span>[<span class="number">0</span>]: <span class="ident">features</span>[<span class="number">1</span>]
|
||||
}
|
||||
});</code></pre></div>
|
||||
<p>Trailing commas are allowed inside both arrays and objects.</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">value</span> <span class="op">=</span> <span class="macro">json!</span>([
|
||||
<span class="string">"notice"</span>,
|
||||
<span class="string">"the"</span>,
|
||||
<span class="string">"trailing"</span>,
|
||||
<span class="string">"comma -->"</span>,
|
||||
]);</code></pre></div>
|
||||
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="serde_json" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>
|
||||
53
doc/serde_json/map/enum.Entry.html
Normal file
53
doc/serde_json/map/enum.Entry.html
Normal file
File diff suppressed because one or more lines are too long
15
doc/serde_json/map/index.html
Normal file
15
doc/serde_json/map/index.html
Normal file
@ -0,0 +1,15 @@
|
||||
<!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="A map of String to serde_json::Value."><meta name="keywords" content="rust, rustlang, rust-lang, map"><title>serde_json::map - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../../serde_json/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../serde_json/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Module map</a></h2><div class="sidebar-elems"><section><div class="block"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li></ul></div></section></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../serde_json/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Module <a href="../index.html">serde_json</a>::<wbr><a class="mod" href="#">map</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../src/serde_json/map.rs.html#1-940">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A map of String to serde_json::Value.</p>
|
||||
<p>By default the map is backed by a <a href="https://doc.rust-lang.org/std/collections/struct.BTreeMap.html"><code>BTreeMap</code></a>. Enable the <code>preserve_order</code>
|
||||
feature of serde_json to use <a href="https://docs.rs/indexmap/*/indexmap/map/struct.IndexMap.html"><code>IndexMap</code></a> instead.</p>
|
||||
</div></details><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.IntoIter.html" title="serde_json::map::IntoIter struct">IntoIter</a></div><div class="item-right docblock-short"><p>An owning iterator over a serde_json::Map’s entries.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Iter.html" title="serde_json::map::Iter struct">Iter</a></div><div class="item-right docblock-short"><p>An iterator over a serde_json::Map’s entries.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.IterMut.html" title="serde_json::map::IterMut struct">IterMut</a></div><div class="item-right docblock-short"><p>A mutable iterator over a serde_json::Map’s entries.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Keys.html" title="serde_json::map::Keys struct">Keys</a></div><div class="item-right docblock-short"><p>An iterator over a serde_json::Map’s keys.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Map.html" title="serde_json::map::Map struct">Map</a></div><div class="item-right docblock-short"><p>Represents a JSON key/value type.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.OccupiedEntry.html" title="serde_json::map::OccupiedEntry struct">OccupiedEntry</a></div><div class="item-right docblock-short"><p>An occupied Entry. It is part of the <a href="enum.Entry.html"><code>Entry</code></a> enum.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.VacantEntry.html" title="serde_json::map::VacantEntry struct">VacantEntry</a></div><div class="item-right docblock-short"><p>A vacant Entry. It is part of the <a href="enum.Entry.html"><code>Entry</code></a> enum.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Values.html" title="serde_json::map::Values struct">Values</a></div><div class="item-right docblock-short"><p>An iterator over a serde_json::Map’s values.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.ValuesMut.html" title="serde_json::map::ValuesMut struct">ValuesMut</a></div><div class="item-right docblock-short"><p>A mutable iterator over a serde_json::Map’s values.</p>
|
||||
</div></div></div><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.Entry.html" title="serde_json::map::Entry enum">Entry</a></div><div class="item-right docblock-short"><p>A view into a single entry in a map, which may either be vacant or occupied.
|
||||
This enum is constructed from the <a href="struct.Map.html#method.entry"><code>entry</code></a> method on <a href="struct.Map.html"><code>Map</code></a>.</p>
|
||||
</div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="serde_json" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>
|
||||
1
doc/serde_json/map/sidebar-items.js
Normal file
1
doc/serde_json/map/sidebar-items.js
Normal file
@ -0,0 +1 @@
|
||||
window.SIDEBAR_ITEMS = {"enum":[["Entry","A view into a single entry in a map, which may either be vacant or occupied. This enum is constructed from the `entry` method on `Map`."]],"struct":[["IntoIter","An owning iterator over a serde_json::Map’s entries."],["Iter","An iterator over a serde_json::Map’s entries."],["IterMut","A mutable iterator over a serde_json::Map’s entries."],["Keys","An iterator over a serde_json::Map’s keys."],["Map","Represents a JSON key/value type."],["OccupiedEntry","An occupied Entry. It is part of the `Entry` enum."],["VacantEntry","A vacant Entry. It is part of the `Entry` enum."],["Values","An iterator over a serde_json::Map’s values."],["ValuesMut","A mutable iterator over a serde_json::Map’s values."]]};
|
||||
139
doc/serde_json/map/struct.IntoIter.html
Normal file
139
doc/serde_json/map/struct.IntoIter.html
Normal file
File diff suppressed because one or more lines are too long
139
doc/serde_json/map/struct.Iter.html
Normal file
139
doc/serde_json/map/struct.Iter.html
Normal file
File diff suppressed because one or more lines are too long
139
doc/serde_json/map/struct.IterMut.html
Normal file
139
doc/serde_json/map/struct.IterMut.html
Normal file
File diff suppressed because one or more lines are too long
139
doc/serde_json/map/struct.Keys.html
Normal file
139
doc/serde_json/map/struct.Keys.html
Normal file
File diff suppressed because one or more lines are too long
101
doc/serde_json/map/struct.Map.html
Normal file
101
doc/serde_json/map/struct.Map.html
Normal file
File diff suppressed because one or more lines are too long
97
doc/serde_json/map/struct.OccupiedEntry.html
Normal file
97
doc/serde_json/map/struct.OccupiedEntry.html
Normal file
File diff suppressed because one or more lines are too long
39
doc/serde_json/map/struct.VacantEntry.html
Normal file
39
doc/serde_json/map/struct.VacantEntry.html
Normal file
File diff suppressed because one or more lines are too long
139
doc/serde_json/map/struct.Values.html
Normal file
139
doc/serde_json/map/struct.Values.html
Normal file
File diff suppressed because one or more lines are too long
139
doc/serde_json/map/struct.ValuesMut.html
Normal file
139
doc/serde_json/map/struct.ValuesMut.html
Normal file
File diff suppressed because one or more lines are too long
11
doc/serde_json/number/struct.Number.html
Normal file
11
doc/serde_json/number/struct.Number.html
Normal file
@ -0,0 +1,11 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../serde_json/value/struct.Number.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../serde_json/value/struct.Number.html">../../serde_json/value/struct.Number.html</a>...</p>
|
||||
<script>location.replace("../../serde_json/value/struct.Number.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
11
doc/serde_json/read/struct.IoRead.html
Normal file
11
doc/serde_json/read/struct.IoRead.html
Normal file
@ -0,0 +1,11 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../serde_json/de/struct.IoRead.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../serde_json/de/struct.IoRead.html">../../serde_json/de/struct.IoRead.html</a>...</p>
|
||||
<script>location.replace("../../serde_json/de/struct.IoRead.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
11
doc/serde_json/read/struct.SliceRead.html
Normal file
11
doc/serde_json/read/struct.SliceRead.html
Normal file
@ -0,0 +1,11 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../serde_json/de/struct.SliceRead.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../serde_json/de/struct.SliceRead.html">../../serde_json/de/struct.SliceRead.html</a>...</p>
|
||||
<script>location.replace("../../serde_json/de/struct.SliceRead.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
11
doc/serde_json/read/struct.StrRead.html
Normal file
11
doc/serde_json/read/struct.StrRead.html
Normal file
@ -0,0 +1,11 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../serde_json/de/struct.StrRead.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../serde_json/de/struct.StrRead.html">../../serde_json/de/struct.StrRead.html</a>...</p>
|
||||
<script>location.replace("../../serde_json/de/struct.StrRead.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
11
doc/serde_json/read/trait.Read.html
Normal file
11
doc/serde_json/read/trait.Read.html
Normal file
@ -0,0 +1,11 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../serde_json/de/trait.Read.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../serde_json/de/trait.Read.html">../../serde_json/de/trait.Read.html</a>...</p>
|
||||
<script>location.replace("../../serde_json/de/trait.Read.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
33
doc/serde_json/ser/enum.CharEscape.html
Normal file
33
doc/serde_json/ser/enum.CharEscape.html
Normal file
File diff suppressed because one or more lines are too long
5
doc/serde_json/ser/fn.to_string.html
Normal file
5
doc/serde_json/ser/fn.to_string.html
Normal file
@ -0,0 +1,5 @@
|
||||
<!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="Serialize the given data structure as a String of JSON."><meta name="keywords" content="rust, rustlang, rust-lang, to_string"><title>to_string in serde_json::ser - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../../serde_json/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../serde_json/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In serde_json::ser</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../serde_json/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Function <a href="../index.html">serde_json</a>::<wbr><a href="index.html">ser</a>::<wbr><a class="fn" href="#">to_string</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../src/serde_json/ser.rs.html#2139-2149">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub fn to_string<T>(value: <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.reference.html">&</a>T) -> <a class="type" href="../type.Result.html" title="type serde_json::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>> <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="../../serde/ser/trait.Serialize.html" title="trait serde::ser::Serialize">Serialize</a>, </span></code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Serialize the given data structure as a String of JSON.</p>
|
||||
<h2 id="errors"><a href="#errors">Errors</a></h2>
|
||||
<p>Serialization can fail if <code>T</code>’s implementation of <code>Serialize</code> decides to
|
||||
fail, or if <code>T</code> contains a map with non-string keys.</p>
|
||||
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="serde_json" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>
|
||||
5
doc/serde_json/ser/fn.to_string_pretty.html
Normal file
5
doc/serde_json/ser/fn.to_string_pretty.html
Normal file
@ -0,0 +1,5 @@
|
||||
<!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="Serialize the given data structure as a pretty-printed String of JSON."><meta name="keywords" content="rust, rustlang, rust-lang, to_string_pretty"><title>to_string_pretty in serde_json::ser - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../../serde_json/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../serde_json/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In serde_json::ser</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../serde_json/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Function <a href="../index.html">serde_json</a>::<wbr><a href="index.html">ser</a>::<wbr><a class="fn" href="#">to_string_pretty</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../src/serde_json/ser.rs.html#2158-2168">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub fn to_string_pretty<T>(value: <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.reference.html">&</a>T) -> <a class="type" href="../type.Result.html" title="type serde_json::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>> <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="../../serde/ser/trait.Serialize.html" title="trait serde::ser::Serialize">Serialize</a>, </span></code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Serialize the given data structure as a pretty-printed String of JSON.</p>
|
||||
<h2 id="errors"><a href="#errors">Errors</a></h2>
|
||||
<p>Serialization can fail if <code>T</code>’s implementation of <code>Serialize</code> decides to
|
||||
fail, or if <code>T</code> contains a map with non-string keys.</p>
|
||||
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="serde_json" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>
|
||||
5
doc/serde_json/ser/fn.to_vec.html
Normal file
5
doc/serde_json/ser/fn.to_vec.html
Normal file
@ -0,0 +1,5 @@
|
||||
<!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="Serialize the given data structure as a JSON byte vector."><meta name="keywords" content="rust, rustlang, rust-lang, to_vec"><title>to_vec in serde_json::ser - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../../serde_json/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../serde_json/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In serde_json::ser</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../serde_json/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Function <a href="../index.html">serde_json</a>::<wbr><a href="index.html">ser</a>::<wbr><a class="fn" href="#">to_vec</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../src/serde_json/ser.rs.html#2107-2114">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub fn to_vec<T>(value: <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.reference.html">&</a>T) -> <a class="type" href="../type.Result.html" title="type serde_json::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.u8.html">u8</a>>> <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="../../serde/ser/trait.Serialize.html" title="trait serde::ser::Serialize">Serialize</a>, </span></code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Serialize the given data structure as a JSON byte vector.</p>
|
||||
<h2 id="errors"><a href="#errors">Errors</a></h2>
|
||||
<p>Serialization can fail if <code>T</code>’s implementation of <code>Serialize</code> decides to
|
||||
fail, or if <code>T</code> contains a map with non-string keys.</p>
|
||||
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="serde_json" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>
|
||||
5
doc/serde_json/ser/fn.to_vec_pretty.html
Normal file
5
doc/serde_json/ser/fn.to_vec_pretty.html
Normal file
File diff suppressed because one or more lines are too long
5
doc/serde_json/ser/fn.to_writer.html
Normal file
5
doc/serde_json/ser/fn.to_writer.html
Normal file
File diff suppressed because one or more lines are too long
6
doc/serde_json/ser/fn.to_writer_pretty.html
Normal file
6
doc/serde_json/ser/fn.to_writer_pretty.html
Normal file
File diff suppressed because one or more lines are too long
15
doc/serde_json/ser/index.html
Normal file
15
doc/serde_json/ser/index.html
Normal file
@ -0,0 +1,15 @@
|
||||
<!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="Serialize a Rust data structure into JSON data."><meta name="keywords" content="rust, rustlang, rust-lang, ser"><title>serde_json::ser - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../../serde_json/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../serde_json/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Module ser</a></h2><div class="sidebar-elems"><section><div class="block"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li></ul></div></section></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../serde_json/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Module <a href="../index.html">serde_json</a>::<wbr><a class="mod" href="#">ser</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../src/serde_json/ser.rs.html#1-2179">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Serialize a Rust data structure into JSON data.</p>
|
||||
</div></details><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.CompactFormatter.html" title="serde_json::ser::CompactFormatter struct">CompactFormatter</a></div><div class="item-right docblock-short"><p>This structure compacts a JSON value with no extra whitespace.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.PrettyFormatter.html" title="serde_json::ser::PrettyFormatter struct">PrettyFormatter</a></div><div class="item-right docblock-short"><p>This structure pretty prints a JSON value to make it human readable.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Serializer.html" title="serde_json::ser::Serializer struct">Serializer</a></div><div class="item-right docblock-short"><p>A structure for serializing Rust values into JSON.</p>
|
||||
</div></div></div><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.CharEscape.html" title="serde_json::ser::CharEscape enum">CharEscape</a></div><div class="item-right docblock-short"><p>Represents a character escape code in a type-safe manner.</p>
|
||||
</div></div></div><h2 id="traits" class="small-section-header"><a href="#traits">Traits</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.Formatter.html" title="serde_json::ser::Formatter trait">Formatter</a></div><div class="item-right docblock-short"><p>This trait abstracts away serializing the JSON control characters, which allows the user to
|
||||
optionally pretty print the JSON output.</p>
|
||||
</div></div></div><h2 id="functions" class="small-section-header"><a href="#functions">Functions</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.to_string.html" title="serde_json::ser::to_string fn">to_string</a></div><div class="item-right docblock-short"><p>Serialize the given data structure as a String of JSON.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.to_string_pretty.html" title="serde_json::ser::to_string_pretty fn">to_string_pretty</a></div><div class="item-right docblock-short"><p>Serialize the given data structure as a pretty-printed String of JSON.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.to_vec.html" title="serde_json::ser::to_vec fn">to_vec</a></div><div class="item-right docblock-short"><p>Serialize the given data structure as a JSON byte vector.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.to_vec_pretty.html" title="serde_json::ser::to_vec_pretty fn">to_vec_pretty</a></div><div class="item-right docblock-short"><p>Serialize the given data structure as a pretty-printed JSON byte vector.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.to_writer.html" title="serde_json::ser::to_writer fn">to_writer</a></div><div class="item-right docblock-short"><p>Serialize the given data structure as JSON into the IO stream.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.to_writer_pretty.html" title="serde_json::ser::to_writer_pretty fn">to_writer_pretty</a></div><div class="item-right docblock-short"><p>Serialize the given data structure as pretty-printed JSON into the IO
|
||||
stream.</p>
|
||||
</div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="serde_json" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>
|
||||
1
doc/serde_json/ser/sidebar-items.js
Normal file
1
doc/serde_json/ser/sidebar-items.js
Normal file
@ -0,0 +1 @@
|
||||
window.SIDEBAR_ITEMS = {"enum":[["CharEscape","Represents a character escape code in a type-safe manner."]],"fn":[["to_string","Serialize the given data structure as a String of JSON."],["to_string_pretty","Serialize the given data structure as a pretty-printed String of JSON."],["to_vec","Serialize the given data structure as a JSON byte vector."],["to_vec_pretty","Serialize the given data structure as a pretty-printed JSON byte vector."],["to_writer","Serialize the given data structure as JSON into the IO stream."],["to_writer_pretty","Serialize the given data structure as pretty-printed JSON into the IO stream."]],"struct":[["CompactFormatter","This structure compacts a JSON value with no extra whitespace."],["PrettyFormatter","This structure pretty prints a JSON value to make it human readable."],["Serializer","A structure for serializing Rust values into JSON."]],"trait":[["Formatter","This trait abstracts away serializing the JSON control characters, which allows the user to optionally pretty print the JSON output."]]};
|
||||
62
doc/serde_json/ser/struct.CompactFormatter.html
Normal file
62
doc/serde_json/ser/struct.CompactFormatter.html
Normal file
File diff suppressed because one or more lines are too long
65
doc/serde_json/ser/struct.PrettyFormatter.html
Normal file
65
doc/serde_json/ser/struct.PrettyFormatter.html
Normal file
File diff suppressed because one or more lines are too long
86
doc/serde_json/ser/struct.Serializer.html
Normal file
86
doc/serde_json/ser/struct.Serializer.html
Normal file
File diff suppressed because one or more lines are too long
107
doc/serde_json/ser/trait.Formatter.html
Normal file
107
doc/serde_json/ser/trait.Formatter.html
Normal file
File diff suppressed because one or more lines are too long
1
doc/serde_json/sidebar-items.js
Normal file
1
doc/serde_json/sidebar-items.js
Normal file
@ -0,0 +1 @@
|
||||
window.SIDEBAR_ITEMS = {"enum":[["Value","Represents any valid JSON value."]],"fn":[["from_reader","Deserialize an instance of type `T` from an IO stream of JSON."],["from_slice","Deserialize an instance of type `T` from bytes of JSON text."],["from_str","Deserialize an instance of type `T` from a string of JSON text."],["from_value","Interpret a `serde_json::Value` as an instance of type `T`."],["to_string","Serialize the given data structure as a String of JSON."],["to_string_pretty","Serialize the given data structure as a pretty-printed String of JSON."],["to_value","Convert a `T` into `serde_json::Value` which is an enum that can represent any valid JSON data."],["to_vec","Serialize the given data structure as a JSON byte vector."],["to_vec_pretty","Serialize the given data structure as a pretty-printed JSON byte vector."],["to_writer","Serialize the given data structure as JSON into the IO stream."],["to_writer_pretty","Serialize the given data structure as pretty-printed JSON into the IO stream."]],"macro":[["json","Construct a `serde_json::Value` from a JSON literal."]],"mod":[["de","Deserialize JSON data to a Rust data structure."],["error","When serializing or deserializing JSON goes wrong."],["map","A map of String to serde_json::Value."],["ser","Serialize a Rust data structure into JSON data."],["value","The Value enum, a loosely typed way of representing any valid JSON value."]],"struct":[["Deserializer","A structure that deserializes JSON into Rust values."],["Error","This type represents all possible errors that can occur when serializing or deserializing JSON data."],["Map","Represents a JSON key/value type."],["Number","Represents a JSON number, whether integer or floating point."],["Serializer","A structure for serializing Rust values into JSON."],["StreamDeserializer","Iterator that deserializes a stream into multiple JSON values."]],"type":[["Result","Alias for a `Result` with the error type `serde_json::Error`."]]};
|
||||
133
doc/serde_json/struct.Deserializer.html
Normal file
133
doc/serde_json/struct.Deserializer.html
Normal file
File diff suppressed because one or more lines are too long
92
doc/serde_json/struct.Error.html
Normal file
92
doc/serde_json/struct.Error.html
Normal file
File diff suppressed because one or more lines are too long
101
doc/serde_json/struct.Map.html
Normal file
101
doc/serde_json/struct.Map.html
Normal file
File diff suppressed because one or more lines are too long
221
doc/serde_json/struct.Number.html
Normal file
221
doc/serde_json/struct.Number.html
Normal file
File diff suppressed because one or more lines are too long
86
doc/serde_json/struct.Serializer.html
Normal file
86
doc/serde_json/struct.Serializer.html
Normal file
File diff suppressed because one or more lines are too long
178
doc/serde_json/struct.StreamDeserializer.html
Normal file
178
doc/serde_json/struct.StreamDeserializer.html
Normal file
File diff suppressed because one or more lines are too long
2
doc/serde_json/type.Result.html
Normal file
2
doc/serde_json/type.Result.html
Normal file
@ -0,0 +1,2 @@
|
||||
<!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="Alias for a `Result` with the error type `serde_json::Error`."><meta name="keywords" content="rust, rustlang, rust-lang, Result"><title>Result in serde_json - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><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="../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../dark.css" disabled><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../main.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></head><body class="rustdoc type"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../serde_json/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../serde_json/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Result</a></h2><div class="sidebar-elems"><h2 class="location"><a href="index.html">In serde_json</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../serde_json/index.html"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Type Definition <a href="index.html">serde_json</a>::<wbr><a class="type" href="#">Result</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../src/serde_json/error.rs.html#23">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="docblock item-decl"><pre class="rust typedef"><code>pub type Result<T> = <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <a class="struct" href="struct.Error.html" title="struct serde_json::Error">Error</a>>;</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Alias for a <code>Result</code> with the error type <code>serde_json::Error</code>.</p>
|
||||
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="serde_json" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>
|
||||
819
doc/serde_json/value/enum.Value.html
Normal file
819
doc/serde_json/value/enum.Value.html
Normal file
File diff suppressed because one or more lines are too long
30
doc/serde_json/value/fn.from_value.html
Normal file
30
doc/serde_json/value/fn.from_value.html
Normal file
@ -0,0 +1,30 @@
|
||||
<!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="Interpret a `serde_json::Value` as an instance of type `T`."><meta name="keywords" content="rust, rustlang, rust-lang, from_value"><title>from_value in serde_json::value - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../../serde_json/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../serde_json/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In serde_json::value</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../serde_json/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Function <a href="../index.html">serde_json</a>::<wbr><a href="index.html">value</a>::<wbr><a class="fn" href="#">from_value</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../src/serde_json/value/mod.rs.html#982-987">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub fn from_value<T>(value: <a class="enum" href="../enum.Value.html" title="enum serde_json::Value">Value</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <a class="struct" href="../struct.Error.html" title="struct serde_json::Error">Error</a>> <span class="where fmt-newline">where<br> T: <a class="trait" href="../../serde/de/trait.DeserializeOwned.html" title="trait serde::de::DeserializeOwned">DeserializeOwned</a>, </span></code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Interpret a <code>serde_json::Value</code> as an instance of type <code>T</code>.</p>
|
||||
<h2 id="example"><a href="#example">Example</a></h2>
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">serde::Deserialize</span>;
|
||||
<span class="kw">use</span> <span class="ident">serde_json::json</span>;
|
||||
|
||||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Deserialize</span>, <span class="ident">Debug</span>)]</span>
|
||||
<span class="kw">struct</span> <span class="ident">User</span> {
|
||||
<span class="ident">fingerprint</span>: <span class="ident">String</span>,
|
||||
<span class="ident">location</span>: <span class="ident">String</span>,
|
||||
}
|
||||
|
||||
<span class="kw">fn</span> <span class="ident">main</span>() {
|
||||
<span class="comment">// The type of `j` is `serde_json::Value`</span>
|
||||
<span class="kw">let</span> <span class="ident">j</span> <span class="op">=</span> <span class="macro">json!</span>({
|
||||
<span class="string">"fingerprint"</span>: <span class="string">"0xF9BA143B95FF6D82"</span>,
|
||||
<span class="string">"location"</span>: <span class="string">"Menlo Park, CA"</span>
|
||||
});
|
||||
|
||||
<span class="kw">let</span> <span class="ident">u</span>: <span class="ident">User</span> <span class="op">=</span> <span class="ident">serde_json::from_value</span>(<span class="ident">j</span>).<span class="ident">unwrap</span>();
|
||||
<span class="macro">println!</span>(<span class="string">"{:#?}"</span>, <span class="ident">u</span>);
|
||||
}</code></pre></div>
|
||||
<h2 id="errors"><a href="#errors">Errors</a></h2>
|
||||
<p>This conversion can fail if the structure of the Value does not match the
|
||||
structure expected by <code>T</code>, for example if <code>T</code> is a struct type but the Value
|
||||
contains something other than a JSON map. It can also fail if the structure
|
||||
is correct but <code>T</code>’s implementation of <code>Deserialize</code> decides that something
|
||||
is wrong with the data, for example required struct fields are missing from
|
||||
the JSON map or some number is too big to fit in the expected primitive
|
||||
type.</p>
|
||||
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="serde_json" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>
|
||||
45
doc/serde_json/value/fn.to_value.html
Normal file
45
doc/serde_json/value/fn.to_value.html
Normal file
@ -0,0 +1,45 @@
|
||||
<!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="Convert a `T` into `serde_json::Value` which is an enum that can represent any valid JSON data."><meta name="keywords" content="rust, rustlang, rust-lang, to_value"><title>to_value in serde_json::value - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../../serde_json/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../serde_json/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In serde_json::value</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../serde_json/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Function <a href="../index.html">serde_json</a>::<wbr><a href="index.html">value</a>::<wbr><a class="fn" href="#">to_value</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../src/serde_json/value/mod.rs.html#940-945">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub fn to_value<T>(value: T) -> <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="enum" href="../enum.Value.html" title="enum serde_json::Value">Value</a>, <a class="struct" href="../struct.Error.html" title="struct serde_json::Error">Error</a>> <span class="where fmt-newline">where<br> T: <a class="trait" href="../../serde/ser/trait.Serialize.html" title="trait serde::ser::Serialize">Serialize</a>, </span></code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Convert a <code>T</code> into <code>serde_json::Value</code> which is an enum that can represent
|
||||
any valid JSON data.</p>
|
||||
<h2 id="example"><a href="#example">Example</a></h2>
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">serde::Serialize</span>;
|
||||
<span class="kw">use</span> <span class="ident">serde_json::json</span>;
|
||||
|
||||
<span class="kw">use</span> <span class="ident">std::error::Error</span>;
|
||||
|
||||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Serialize</span>)]</span>
|
||||
<span class="kw">struct</span> <span class="ident">User</span> {
|
||||
<span class="ident">fingerprint</span>: <span class="ident">String</span>,
|
||||
<span class="ident">location</span>: <span class="ident">String</span>,
|
||||
}
|
||||
|
||||
<span class="kw">fn</span> <span class="ident">compare_json_values</span>() -> <span class="prelude-ty">Result</span><span class="op"><</span>(), <span class="ident">Box</span><span class="op"><</span><span class="ident">Error</span><span class="op">></span><span class="op">></span> {
|
||||
<span class="kw">let</span> <span class="ident">u</span> <span class="op">=</span> <span class="ident">User</span> {
|
||||
<span class="ident">fingerprint</span>: <span class="string">"0xF9BA143B95FF6D82"</span>.<span class="ident">to_owned</span>(),
|
||||
<span class="ident">location</span>: <span class="string">"Menlo Park, CA"</span>.<span class="ident">to_owned</span>(),
|
||||
};
|
||||
|
||||
<span class="comment">// The type of `expected` is `serde_json::Value`</span>
|
||||
<span class="kw">let</span> <span class="ident">expected</span> <span class="op">=</span> <span class="macro">json!</span>({
|
||||
<span class="string">"fingerprint"</span>: <span class="string">"0xF9BA143B95FF6D82"</span>,
|
||||
<span class="string">"location"</span>: <span class="string">"Menlo Park, CA"</span>,
|
||||
});
|
||||
|
||||
<span class="kw">let</span> <span class="ident">v</span> <span class="op">=</span> <span class="ident">serde_json::to_value</span>(<span class="ident">u</span>).<span class="ident">unwrap</span>();
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">v</span>, <span class="ident">expected</span>);
|
||||
|
||||
<span class="prelude-val">Ok</span>(())
|
||||
}</code></pre></div>
|
||||
<h2 id="errors"><a href="#errors">Errors</a></h2>
|
||||
<p>This conversion can fail if <code>T</code>’s implementation of <code>Serialize</code> decides to
|
||||
fail, or if <code>T</code> contains a map with non-string keys.</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">std::collections::BTreeMap</span>;
|
||||
|
||||
<span class="kw">fn</span> <span class="ident">main</span>() {
|
||||
<span class="comment">// The keys in this map are vectors, not strings.</span>
|
||||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">map</span> <span class="op">=</span> <span class="ident">BTreeMap::new</span>();
|
||||
<span class="ident">map</span>.<span class="ident">insert</span>(<span class="macro">vec!</span>[<span class="number">32</span>, <span class="number">64</span>], <span class="string">"x86"</span>);
|
||||
|
||||
<span class="macro">println!</span>(<span class="string">"{}"</span>, <span class="ident">serde_json::to_value</span>(<span class="ident">map</span>).<span class="ident">unwrap_err</span>());
|
||||
}</code></pre></div>
|
||||
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="serde_json" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>
|
||||
77
doc/serde_json/value/index.html
Normal file
77
doc/serde_json/value/index.html
Normal file
@ -0,0 +1,77 @@
|
||||
<!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="The Value enum, a loosely typed way of representing any valid JSON value."><meta name="keywords" content="rust, rustlang, rust-lang, value"><title>serde_json::value - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../../serde_json/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../serde_json/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Module value</a></h2><div class="sidebar-elems"><section><div class="block"><ul><li><a href="#reexports">Re-exports</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li></ul></div></section></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../serde_json/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Module <a href="../index.html">serde_json</a>::<wbr><a class="mod" href="#">value</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../src/serde_json/value/mod.rs.html#1-987">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>The Value enum, a loosely typed way of representing any valid JSON value.</p>
|
||||
<h2 id="constructing-json"><a href="#constructing-json">Constructing JSON</a></h2>
|
||||
<p>Serde JSON provides a <a href="https://docs.serde.rs/serde_json/macro.json.html"><code>json!</code> macro</a> to build <code>serde_json::Value</code>
|
||||
objects with very natural JSON syntax.</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">serde_json::json</span>;
|
||||
|
||||
<span class="kw">fn</span> <span class="ident">main</span>() {
|
||||
<span class="comment">// The type of `john` is `serde_json::Value`</span>
|
||||
<span class="kw">let</span> <span class="ident">john</span> <span class="op">=</span> <span class="macro">json!</span>({
|
||||
<span class="string">"name"</span>: <span class="string">"John Doe"</span>,
|
||||
<span class="string">"age"</span>: <span class="number">43</span>,
|
||||
<span class="string">"phones"</span>: [
|
||||
<span class="string">"+44 1234567"</span>,
|
||||
<span class="string">"+44 2345678"</span>
|
||||
]
|
||||
});
|
||||
|
||||
<span class="macro">println!</span>(<span class="string">"first phone number: {}"</span>, <span class="ident">john</span>[<span class="string">"phones"</span>][<span class="number">0</span>]);
|
||||
|
||||
<span class="comment">// Convert to a string of JSON and print it out</span>
|
||||
<span class="macro">println!</span>(<span class="string">"{}"</span>, <span class="ident">john</span>.<span class="ident">to_string</span>());
|
||||
}</code></pre></div>
|
||||
<p>The <code>Value::to_string()</code> function converts a <code>serde_json::Value</code> into a
|
||||
<code>String</code> of JSON text.</p>
|
||||
<p>One neat thing about the <code>json!</code> macro is that variables and expressions can
|
||||
be interpolated directly into the JSON value as you are building it. Serde
|
||||
will check at compile time that the value you are interpolating is able to
|
||||
be represented as JSON.</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">full_name</span> <span class="op">=</span> <span class="string">"John Doe"</span>;
|
||||
<span class="kw">let</span> <span class="ident">age_last_year</span> <span class="op">=</span> <span class="number">42</span>;
|
||||
|
||||
<span class="comment">// The type of `john` is `serde_json::Value`</span>
|
||||
<span class="kw">let</span> <span class="ident">john</span> <span class="op">=</span> <span class="macro">json!</span>({
|
||||
<span class="string">"name"</span>: <span class="ident">full_name</span>,
|
||||
<span class="string">"age"</span>: <span class="ident">age_last_year</span> <span class="op">+</span> <span class="number">1</span>,
|
||||
<span class="string">"phones"</span>: [
|
||||
<span class="macro">format!</span>(<span class="string">"+44 {}"</span>, <span class="ident">random_phone</span>())
|
||||
]
|
||||
});</code></pre></div>
|
||||
<p>A string of JSON data can be parsed into a <code>serde_json::Value</code> by the
|
||||
<a href="https://docs.serde.rs/serde_json/de/fn.from_str.html"><code>serde_json::from_str</code></a> function. There is also
|
||||
<a href="https://docs.serde.rs/serde_json/de/fn.from_slice.html"><code>from_slice</code></a> for parsing from a byte slice <code>&[u8]</code> and
|
||||
<a href="https://docs.serde.rs/serde_json/de/fn.from_reader.html"><code>from_reader</code></a> for parsing from any <code>io::Read</code> like a File or
|
||||
a TCP stream.</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">serde_json</span>::{<span class="ident">json</span>, <span class="ident">Value</span>, <span class="ident">Error</span>};
|
||||
|
||||
<span class="kw">fn</span> <span class="ident">untyped_example</span>() -> <span class="prelude-ty">Result</span><span class="op"><</span>(), <span class="ident">Error</span><span class="op">></span> {
|
||||
<span class="comment">// Some JSON input data as a &str. Maybe this comes from the user.</span>
|
||||
<span class="kw">let</span> <span class="ident">data</span> <span class="op">=</span> <span class="string">r#"
|
||||
{
|
||||
"name": "John Doe",
|
||||
"age": 43,
|
||||
"phones": [
|
||||
"+44 1234567",
|
||||
"+44 2345678"
|
||||
]
|
||||
}"#</span>;
|
||||
|
||||
<span class="comment">// Parse the string of data into serde_json::Value.</span>
|
||||
<span class="kw">let</span> <span class="ident">v</span>: <span class="ident">Value</span> <span class="op">=</span> <span class="ident">serde_json::from_str</span>(<span class="ident">data</span>)<span class="question-mark">?</span>;
|
||||
|
||||
<span class="comment">// Access parts of the data by indexing with square brackets.</span>
|
||||
<span class="macro">println!</span>(<span class="string">"Please call {} at the number {}"</span>, <span class="ident">v</span>[<span class="string">"name"</span>], <span class="ident">v</span>[<span class="string">"phones"</span>][<span class="number">0</span>]);
|
||||
|
||||
<span class="prelude-val">Ok</span>(())
|
||||
}</code></pre></div>
|
||||
</div></details><h2 id="reexports" class="small-section-header"><a href="#reexports">Re-exports</a></h2><div class="item-table"><div class="item-row"><div class="item-left import-item" id="reexport.Map"><code>pub use crate::map::<a class="struct" href="../struct.Map.html" title="struct serde_json::Map">Map</a>;</code></div><div class="item-right docblock-short"></div></div></div><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Number.html" title="serde_json::value::Number struct">Number</a></div><div class="item-right docblock-short"><p>Represents a JSON number, whether integer or floating point.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Serializer.html" title="serde_json::value::Serializer struct">Serializer</a></div><div class="item-right docblock-short"><p>Serializer whose output is a <code>Value</code>.</p>
|
||||
</div></div></div><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.Value.html" title="serde_json::value::Value enum">Value</a></div><div class="item-right docblock-short"><p>Represents any valid JSON value.</p>
|
||||
</div></div></div><h2 id="traits" class="small-section-header"><a href="#traits">Traits</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.Index.html" title="serde_json::value::Index trait">Index</a></div><div class="item-right docblock-short"><p>A type that can be used to index into a <code>serde_json::Value</code>.</p>
|
||||
</div></div></div><h2 id="functions" class="small-section-header"><a href="#functions">Functions</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.from_value.html" title="serde_json::value::from_value fn">from_value</a></div><div class="item-right docblock-short"><p>Interpret a <code>serde_json::Value</code> as an instance of type <code>T</code>.</p>
|
||||
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.to_value.html" title="serde_json::value::to_value fn">to_value</a></div><div class="item-right docblock-short"><p>Convert a <code>T</code> into <code>serde_json::Value</code> which is an enum that can represent
|
||||
any valid JSON data.</p>
|
||||
</div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="serde_json" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>
|
||||
11
doc/serde_json/value/index/trait.Index.html
Normal file
11
doc/serde_json/value/index/trait.Index.html
Normal file
@ -0,0 +1,11 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../../serde_json/value/trait.Index.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../../serde_json/value/trait.Index.html">../../../serde_json/value/trait.Index.html</a>...</p>
|
||||
<script>location.replace("../../../serde_json/value/trait.Index.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
11
doc/serde_json/value/ser/struct.Serializer.html
Normal file
11
doc/serde_json/value/ser/struct.Serializer.html
Normal file
@ -0,0 +1,11 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../../serde_json/value/struct.Serializer.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../../serde_json/value/struct.Serializer.html">../../../serde_json/value/struct.Serializer.html</a>...</p>
|
||||
<script>location.replace("../../../serde_json/value/struct.Serializer.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
1
doc/serde_json/value/sidebar-items.js
Normal file
1
doc/serde_json/value/sidebar-items.js
Normal file
@ -0,0 +1 @@
|
||||
window.SIDEBAR_ITEMS = {"enum":[["Value","Represents any valid JSON value."]],"fn":[["from_value","Interpret a `serde_json::Value` as an instance of type `T`."],["to_value","Convert a `T` into `serde_json::Value` which is an enum that can represent any valid JSON data."]],"struct":[["Number","Represents a JSON number, whether integer or floating point."],["Serializer","Serializer whose output is a `Value`."]],"trait":[["Index","A type that can be used to index into a `serde_json::Value`."]]};
|
||||
221
doc/serde_json/value/struct.Number.html
Normal file
221
doc/serde_json/value/struct.Number.html
Normal file
File diff suppressed because one or more lines are too long
96
doc/serde_json/value/struct.Serializer.html
Normal file
96
doc/serde_json/value/struct.Serializer.html
Normal file
File diff suppressed because one or more lines are too long
18
doc/serde_json/value/trait.Index.html
Normal file
18
doc/serde_json/value/trait.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="A type that can be used to index into a `serde_json::Value`."><meta name="keywords" content="rust, rustlang, rust-lang, Index"><title>Index in serde_json::value - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../../serde_json/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../serde_json/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Index</a></h2><div class="sidebar-elems"><section><div class="block"><h3 class="sidebar-title"><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul><li><a href="#impl-Index-for-%26%27a%20T">&'a T</a></li><li><a href="#impl-Index-for-String">String</a></li><li><a href="#impl-Index-for-str">str</a></li><li><a href="#impl-Index-for-usize">usize</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#implementors">Implementors</a></h3></div></section><h2 class="location"><a href="index.html">In serde_json::value</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../serde_json/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Trait <a href="../index.html">serde_json</a>::<wbr><a href="index.html">value</a>::<wbr><a class="trait" href="#">Index</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../src/serde_json/value/index.rs.html#37-52">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="docblock item-decl"><pre class="rust trait"><code>pub trait Index: Sealed { }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A type that can be used to index into a <code>serde_json::Value</code>.</p>
|
||||
<p>The <a href="../enum.Value.html#method.get"><code>get</code></a> and <a href="../enum.Value.html#method.get_mut"><code>get_mut</code></a> methods of <code>Value</code> accept any type that
|
||||
implements <code>Index</code>, as does the <a href="../enum.Value.html#impl-Index%3CI%3E">square-bracket indexing operator</a>. This
|
||||
trait is implemented for strings which are used as the index into a JSON
|
||||
map, and for <code>usize</code> which is used as the index into a JSON array.</p>
|
||||
<p>This trait is sealed and cannot be implemented for types outside of
|
||||
<code>serde_json</code>.</p>
|
||||
<h2 id="examples"><a href="#examples">Examples</a></h2>
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">data</span> <span class="op">=</span> <span class="macro">json!</span>({ <span class="string">"inner"</span>: [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>] });
|
||||
|
||||
<span class="comment">// Data is a JSON map so it can be indexed with a string.</span>
|
||||
<span class="kw">let</span> <span class="ident">inner</span> <span class="op">=</span> <span class="kw-2">&</span><span class="ident">data</span>[<span class="string">"inner"</span>];
|
||||
|
||||
<span class="comment">// Inner is a JSON array so it can be indexed with an integer.</span>
|
||||
<span class="kw">let</span> <span class="ident">first</span> <span class="op">=</span> <span class="kw-2">&</span><span class="ident">inner</span>[<span class="number">0</span>];
|
||||
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">first</span>, <span class="number">1</span>);</code></pre></div>
|
||||
</div></details><h2 id="foreign-impls" class="small-section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor"></a></h2><section id="impl-Index-for-usize" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/serde_json/value/index.rs.html#54-81">source</a></span><a href="#impl-Index-for-usize" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.Index.html" title="trait serde_json::value::Index">Index</a> for <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.usize.html">usize</a></h3></section><section id="impl-Index-for-str" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/serde_json/value/index.rs.html#83-105">source</a></span><a href="#impl-Index-for-str" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.Index.html" title="trait serde_json::value::Index">Index</a> for <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.str.html">str</a></h3></section><section id="impl-Index-for-String" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/serde_json/value/index.rs.html#107-117">source</a></span><a href="#impl-Index-for-String" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.Index.html" title="trait serde_json::value::Index">Index</a> for <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></h3></section><section id="impl-Index-for-%26%27a%20T" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/serde_json/value/index.rs.html#119-132">source</a></span><a href="#impl-Index-for-%26%27a%20T" class="anchor"></a><h3 class="code-header in-band">impl<'a, T> <a class="trait" href="trait.Index.html" title="trait serde_json::value::Index">Index</a> for <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.reference.html">&'a </a>T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="trait.Index.html" title="trait serde_json::value::Index">Index</a>, </span></h3></section><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"></div><script type="text/javascript" src="../../implementors/serde_json/value/index/trait.Index.js" data-ignore-extern-crates="std,alloc" async></script></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="serde_json" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>
|
||||
Reference in New Issue
Block a user