Now a REAL lib
This commit is contained in:
Justine
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