NotAShelf/mpvrc
1
0
Fork 0
mirror of https://github.com/NotAShelf/mpvrc.git synced 2026-04-18 00:38:14 +00:00
Code Issues Projects Releases Packages Wiki Activity

deploy: de38ae62916547ad097c066f94a32e9ba7790eeb

Browse source
This commit is contained in:
NotAShelf 2025-02-05 00:10:33 +00:00
commit 9a86359447
28502 changed files with 1261284 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

756
serde_json/value/enum.Value.html Normal file
View file

File diff suppressed because one or more lines are too long

31
serde_json/value/fn.from_value.html Normal file
View file

@ -0,0 +1,31 @@
<!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`."><title>from_value in serde_json::value - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="serde_json" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../serde_json/index.html">serde_<wbr>json</a><span class="version">1.0.133</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">from_<wbr>value</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#example" title="Example">Example</a></li><li><a href="#errors" title="Errors">Errors</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In serde_<wbr>json::<wbr>value</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../index.html">serde_json</a>::<wbr><a href="index.html">value</a></span><h1>Function <span class="fn">from_value</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/serde_json/value/mod.rs.html#1030-1035">Source</a> </span></div><pre class="rust item-decl"><code>pub fn from_value&lt;T&gt;(value: <a class="enum" href="../enum.Value.html" title="enum serde_json::Value">Value</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.84.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, <a class="struct" href="../struct.Error.html" title="struct serde_json::Error">Error</a>&gt;<div class="where">where
T: <a class="trait" href="../../serde/de/trait.DeserializeOwned.html" title="trait serde::de::DeserializeOwned">DeserializeOwned</a>,</div></code></pre><details class="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 class="doc-anchor" href="#example">§</a>Example</h2>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>serde::Deserialize;
<span class="kw">use </span>serde_json::json;
<span class="attr">#[derive(Deserialize, Debug)]
</span><span class="kw">struct </span>User {
fingerprint: String,
location: String,
}
<span class="kw">fn </span>main() {
<span class="comment">// The type of `j` is `serde_json::Value`
</span><span class="kw">let </span>j = <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>u: User = serde_json::from_value(j).unwrap();
<span class="macro">println!</span>(<span class="string">"{:#?}"</span>, u);
}</code></pre></div>
<h2 id="errors"><a class="doc-anchor" href="#errors">§</a>Errors</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></body></html>

45
serde_json/value/fn.to_value.html Normal file
View 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."><title>to_value in serde_json::value - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="serde_json" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../serde_json/index.html">serde_<wbr>json</a><span class="version">1.0.133</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">to_<wbr>value</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#example" title="Example">Example</a></li><li><a href="#errors" title="Errors">Errors</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In serde_<wbr>json::<wbr>value</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../index.html">serde_json</a>::<wbr><a href="index.html">value</a></span><h1>Function <span class="fn">to_value</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/serde_json/value/mod.rs.html#988-993">Source</a> </span></div><pre class="rust item-decl"><code>pub fn to_value&lt;T&gt;(value: T) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.84.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<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>&gt;<div class="where">where
T: <a class="trait" href="../../serde/ser/trait.Serialize.html" title="trait serde::ser::Serialize">Serialize</a>,</div></code></pre><details class="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 class="doc-anchor" href="#example">§</a>Example</h2>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>serde::Serialize;
<span class="kw">use </span>serde_json::json;
<span class="kw">use </span>std::error::Error;
<span class="attr">#[derive(Serialize)]
</span><span class="kw">struct </span>User {
fingerprint: String,
location: String,
}
<span class="kw">fn </span>compare_json_values() -&gt; <span class="prelude-ty">Result</span>&lt;(), Box&lt;<span class="kw">dyn </span>Error&gt;&gt; {
<span class="kw">let </span>u = User {
fingerprint: <span class="string">"0xF9BA143B95FF6D82"</span>.to_owned(),
location: <span class="string">"Menlo Park, CA"</span>.to_owned(),
};
<span class="comment">// The type of `expected` is `serde_json::Value`
</span><span class="kw">let </span>expected = <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>v = serde_json::to_value(u).unwrap();
<span class="macro">assert_eq!</span>(v, expected);
<span class="prelude-val">Ok</span>(())
}</code></pre></div>
<h2 id="errors"><a class="doc-anchor" href="#errors">§</a>Errors</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>std::collections::BTreeMap;
<span class="kw">fn </span>main() {
<span class="comment">// The keys in this map are vectors, not strings.
</span><span class="kw">let </span><span class="kw-2">mut </span>map = BTreeMap::new();
map.insert(<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>, serde_json::to_value(map).unwrap_err());
}</code></pre></div>
</div></details></section></div></main></body></html>

71
serde_json/value/index.html Normal file
View file

@ -0,0 +1,71 @@
<!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."><title>serde_json::value - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="serde_json" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../serde_json/index.html">serde_<wbr>json</a><span class="version">1.0.133</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module value</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#constructing-json" title="Constructing JSON">Constructing JSON</a></li></ul><h3><a href="#reexports">Module Items</a></h3><ul class="block"><li><a href="#reexports" title="Re-exports">Re-exports</a></li><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#traits" title="Traits">Traits</a></li><li><a href="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate serde_<wbr>json</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../index.html">serde_json</a></span><h1>Module <span>value</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/serde_json/value/mod.rs.html#1-1035">Source</a> </span></div><details class="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 class="doc-anchor" href="#constructing-json">§</a>Constructing JSON</h2>
<p>Serde JSON provides a <a href="../macro.json.html" title="macro serde_json::json"><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>serde_json::json;
<span class="kw">fn </span>main() {
<span class="comment">// The type of `john` is `serde_json::Value`
</span><span class="kw">let </span>john = <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>, john[<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>, john.to_string());
}</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>full_name = <span class="string">"John Doe"</span>;
<span class="kw">let </span>age_last_year = <span class="number">42</span>;
<span class="comment">// The type of `john` is `serde_json::Value`
</span><span class="kw">let </span>john = <span class="macro">json!</span>({
<span class="string">"name"</span>: full_name,
<span class="string">"age"</span>: age_last_year + <span class="number">1</span>,
<span class="string">"phones"</span>: [
<span class="macro">format!</span>(<span class="string">"+44 {}"</span>, random_phone())
]
});</code></pre></div>
<p>A string of JSON data can be parsed into a <code>serde_json::Value</code> by the
<a href="../fn.from_str.html" title="fn serde_json::from_str"><code>serde_json::from_str</code></a> function. There is also
<a href="../fn.from_slice.html" title="fn serde_json::from_slice"><code>from_slice</code></a> for parsing from a byte slice <code>&amp;[u8]</code> and
<a href="../fn.from_reader.html" title="fn serde_json::from_reader"><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>serde_json::{json, Value, Error};
<span class="kw">fn </span>untyped_example() -&gt; <span class="prelude-ty">Result</span>&lt;(), Error&gt; {
<span class="comment">// Some JSON input data as a &amp;str. Maybe this comes from the user.
</span><span class="kw">let </span>data = <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>v: Value = serde_json::from_str(data)<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>, v[<span class="string">"name"</span>], v[<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="section-header">Re-exports<a href="#reexports" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name" id="reexport.Map"><code>pub use crate::map::<a class="struct" href="../struct.Map.html" title="struct serde_json::Map">Map</a>;</code></div></li></ul><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.Number.html" title="struct serde_json::value::Number">Number</a></div><div class="desc docblock-short">Represents a JSON number, whether integer or floating point.</div></li><li><div class="item-name"><a class="struct" href="struct.Serializer.html" title="struct serde_json::value::Serializer">Serializer</a></div><div class="desc docblock-short">Serializer whose output is a <code>Value</code>.</div></li></ul><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.Value.html" title="enum serde_json::value::Value">Value</a></div><div class="desc docblock-short">Represents any valid JSON value.</div></li></ul><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.Index.html" title="trait serde_json::value::Index">Index</a></div><div class="desc docblock-short">A type that can be used to index into a <code>serde_json::Value</code>.</div></li></ul><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.from_value.html" title="fn serde_json::value::from_value">from_<wbr>value</a></div><div class="desc docblock-short">Interpret a <code>serde_json::Value</code> as an instance of type <code>T</code>.</div></li><li><div class="item-name"><a class="fn" href="fn.to_value.html" title="fn serde_json::value::to_value">to_<wbr>value</a></div><div class="desc docblock-short">Convert a <code>T</code> into <code>serde_json::Value</code> which is an enum that can represent
any valid JSON data.</div></li></ul></section></div></main></body></html>

11
serde_json/value/index/trait.Index.html Normal file
View 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
serde_json/value/ser/struct.Serializer.html Normal file
View 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
serde_json/value/sidebar-items.js Normal file
View file

@ -0,0 +1 @@
window.SIDEBAR_ITEMS = {"enum":["Value"],"fn":["from_value","to_value"],"struct":["Number","Serializer"],"trait":["Index"]};

290
serde_json/value/struct.Number.html Normal file
View file

File diff suppressed because one or more lines are too long

96
serde_json/value/struct.Serializer.html Normal file
View file

File diff suppressed because one or more lines are too long

19
serde_json/value/trait.Index.html Normal file
View file

@ -0,0 +1,19 @@
<!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`."><title>Index in serde_json::value - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="serde_json" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../serde_json/index.html">serde_<wbr>json</a><span class="version">1.0.133</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Index</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#examples" title="Examples">Examples</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-Index-for-%26T" title="&#38;T">&#38;T</a></li><li><a href="#impl-Index-for-String" title="String">String</a></li><li><a href="#impl-Index-for-str" title="str">str</a></li><li><a href="#impl-Index-for-usize" title="usize">usize</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In serde_<wbr>json::<wbr>value</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../index.html">serde_json</a>::<wbr><a href="index.html">value</a></span><h1>Trait <span class="trait">Index</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/serde_json/value/index.rs.html#37-52">Source</a> </span></div><pre class="rust item-decl"><code>pub trait Index: Sealed { }</code></pre><details class="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-for-Value">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 class="doc-anchor" href="#examples">§</a>Examples</h2>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>data = <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>inner = <span class="kw-2">&amp;</span>data[<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>first = <span class="kw-2">&amp;</span>inner[<span class="number">0</span>];
<span class="macro">assert_eq!</span>(first, <span class="number">1</span>);</code></pre></div>
</div></details><h2 id="foreign-impls" class="section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><section id="impl-Index-for-str" class="impl"><a class="src rightside" href="../../src/serde_json/value/index.rs.html#83-105">Source</a><a href="#impl-Index-for-str" class="anchor">§</a><h3 class="code-header">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.84.1/std/primitive.str.html">str</a></h3></section><section id="impl-Index-for-usize" class="impl"><a class="src rightside" href="../../src/serde_json/value/index.rs.html#54-81">Source</a><a href="#impl-Index-for-usize" class="anchor">§</a><h3 class="code-header">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.84.1/std/primitive.usize.html">usize</a></h3></section><section id="impl-Index-for-String" class="impl"><a class="src rightside" href="../../src/serde_json/value/index.rs.html#107-117">Source</a><a href="#impl-Index-for-String" class="anchor">§</a><h3 class="code-header">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.84.1/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></h3></section><section id="impl-Index-for-%26T" class="impl"><a class="src rightside" href="../../src/serde_json/value/index.rs.html#119-132">Source</a><a href="#impl-Index-for-%26T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <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.84.1/std/primitive.reference.html">&amp;T</a><div class="where">where
T: ?<a class="trait" href="https://doc.rust-lang.org/1.84.1/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>,</div></h3></section><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../../trait.impl/serde_json/value/index/trait.Index.js" data-ignore-extern-crates="std,alloc" async></script></section></div></main></body></html>