Files
GopherGate/target/doc/serde_json/value/trait.Index.html
2026-02-26 12:00:21 -05:00

18 lines
7.5 KiB
HTML

<!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-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.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"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-ca0dd0c4.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.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.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]--><rustdoc-topbar><h2><a href="#">Index</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../serde_json/index.html">serde_<wbr>json</a><span class="version">1.0.149</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" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">serde_json</a>::<wbr><a href="index.html">value</a></div><h1>Trait <span class="trait">Index</span>&nbsp;<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" title="method serde_json::Value::get"><code>get</code></a> and <a href="../enum.Value.html#method.get_mut" title="method serde_json::Value::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" title="enum serde_json::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.93.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.93.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.93.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.93.1/std/primitive.reference.html">&amp;T</a><div class="where">where
T: ?<a class="trait" href="https://doc.rust-lang.org/1.93.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>