21 lines
16 KiB
HTML
21 lines
16 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="API documentation for the Rust `Index` trait in crate `serde_json`."><meta name="keywords" content="rust, rustlang, rust-lang, Index"><title>serde_json::value::Index - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="shortcut icon" href="../../favicon.ico"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc trait"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../serde_json/index.html'><div class='logo-container'><img src='../../rust-logo.png' alt='logo'></div></a><p class='location'>Trait Index</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-Index-for-%26%27a%20T">&'a T</a><a href="#impl-Index-for-String">String</a><a href="#impl-Index-for-str">str</a><a href="#impl-Index-for-usize">usize</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='../index.html'>serde_json</a>::<wbr><a href='index.html'>value</a></p><script>window.sidebarCurrent = {name: 'Index', ty: 'trait', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../../src/serde_json/value/index.rs.html#34-49' title='goto source code'>[src]</a></span><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></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub trait Index: Sealed { }</pre></div><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>
|
||
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="ident">data</span> <span class="op">=</span> <span class="macro">json</span><span class="macro">!</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="macro">!</span>(<span class="ident">first</span>, <span class="number">1</span>);</pre></div>
|
||
</div>
|
||
<h2 id='foreign-impls' class='small-section-header'>Implementations on Foreign Types<a href='#foreign-impls' class='anchor'></a></h2><h3 id='impl-Index-for-usize' class='impl'><code class='in-band'>impl <a class="trait" href="../../serde_json/value/trait.Index.html" title="trait serde_json::value::Index">Index</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code><a href='#impl-Index-for-usize' class='anchor'></a><a class='srclink' href='../../src/serde_json/value/index.rs.html#51-78' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.index_into' class="method hidden"><code id='index_into.v'>fn <a href='#method.index_into' class='fnname'>index_into</a><'v>(&self, v: &'v <a class="enum" href="../../serde_json/value/enum.Value.html" title="enum serde_json::value::Value">Value</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&'v <a class="enum" href="../../serde_json/value/enum.Value.html" title="enum serde_json::value::Value">Value</a>></code><a class='srclink' href='../../src/serde_json/value/index.rs.html#52-57' title='goto source code'>[src]</a></h4><h4 id='method.index_into_mut' class="method hidden"><code id='index_into_mut.v'>fn <a href='#method.index_into_mut' class='fnname'>index_into_mut</a><'v>(&self, v: &'v mut <a class="enum" href="../../serde_json/value/enum.Value.html" title="enum serde_json::value::Value">Value</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&'v mut <a class="enum" href="../../serde_json/value/enum.Value.html" title="enum serde_json::value::Value">Value</a>></code><a class='srclink' href='../../src/serde_json/value/index.rs.html#58-63' title='goto source code'>[src]</a></h4><h4 id='method.index_or_insert' class="method hidden"><code id='index_or_insert.v'>fn <a href='#method.index_or_insert' class='fnname'>index_or_insert</a><'v>(&self, v: &'v mut <a class="enum" href="../../serde_json/value/enum.Value.html" title="enum serde_json::value::Value">Value</a>) -> &'v mut <a class="enum" href="../../serde_json/value/enum.Value.html" title="enum serde_json::value::Value">Value</a></code><a class='srclink' href='../../src/serde_json/value/index.rs.html#64-77' title='goto source code'>[src]</a></h4></div><h3 id='impl-Index-for-str' class='impl'><code class='in-band'>impl <a class="trait" href="../../serde_json/value/trait.Index.html" title="trait serde_json::value::Index">Index</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a></code><a href='#impl-Index-for-str' class='anchor'></a><a class='srclink' href='../../src/serde_json/value/index.rs.html#80-102' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.index_into-1' class="method hidden"><code id='index_into.v-1'>fn <a href='#method.index_into' class='fnname'>index_into</a><'v>(&self, v: &'v <a class="enum" href="../../serde_json/value/enum.Value.html" title="enum serde_json::value::Value">Value</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&'v <a class="enum" href="../../serde_json/value/enum.Value.html" title="enum serde_json::value::Value">Value</a>></code><a class='srclink' href='../../src/serde_json/value/index.rs.html#81-86' title='goto source code'>[src]</a></h4><h4 id='method.index_into_mut-1' class="method hidden"><code id='index_into_mut.v-1'>fn <a href='#method.index_into_mut' class='fnname'>index_into_mut</a><'v>(&self, v: &'v mut <a class="enum" href="../../serde_json/value/enum.Value.html" title="enum serde_json::value::Value">Value</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&'v mut <a class="enum" href="../../serde_json/value/enum.Value.html" title="enum serde_json::value::Value">Value</a>></code><a class='srclink' href='../../src/serde_json/value/index.rs.html#87-92' title='goto source code'>[src]</a></h4><h4 id='method.index_or_insert-1' class="method hidden"><code id='index_or_insert.v-1'>fn <a href='#method.index_or_insert' class='fnname'>index_or_insert</a><'v>(&self, v: &'v mut <a class="enum" href="../../serde_json/value/enum.Value.html" title="enum serde_json::value::Value">Value</a>) -> &'v mut <a class="enum" href="../../serde_json/value/enum.Value.html" title="enum serde_json::value::Value">Value</a></code><a class='srclink' href='../../src/serde_json/value/index.rs.html#93-101' title='goto source code'>[src]</a></h4></div><h3 id='impl-Index-for-String' class='impl'><code class='in-band'>impl <a class="trait" href="../../serde_json/value/trait.Index.html" title="trait serde_json::value::Index">Index</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></code><a href='#impl-Index-for-String' class='anchor'></a><a class='srclink' href='../../src/serde_json/value/index.rs.html#104-114' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.index_into-2' class="method hidden"><code id='index_into.v-2'>fn <a href='#method.index_into' class='fnname'>index_into</a><'v>(&self, v: &'v <a class="enum" href="../../serde_json/value/enum.Value.html" title="enum serde_json::value::Value">Value</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&'v <a class="enum" href="../../serde_json/value/enum.Value.html" title="enum serde_json::value::Value">Value</a>></code><a class='srclink' href='../../src/serde_json/value/index.rs.html#105-107' title='goto source code'>[src]</a></h4><h4 id='method.index_into_mut-2' class="method hidden"><code id='index_into_mut.v-2'>fn <a href='#method.index_into_mut' class='fnname'>index_into_mut</a><'v>(&self, v: &'v mut <a class="enum" href="../../serde_json/value/enum.Value.html" title="enum serde_json::value::Value">Value</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&'v mut <a class="enum" href="../../serde_json/value/enum.Value.html" title="enum serde_json::value::Value">Value</a>></code><a class='srclink' href='../../src/serde_json/value/index.rs.html#108-110' title='goto source code'>[src]</a></h4><h4 id='method.index_or_insert-2' class="method hidden"><code id='index_or_insert.v-2'>fn <a href='#method.index_or_insert' class='fnname'>index_or_insert</a><'v>(&self, v: &'v mut <a class="enum" href="../../serde_json/value/enum.Value.html" title="enum serde_json::value::Value">Value</a>) -> &'v mut <a class="enum" href="../../serde_json/value/enum.Value.html" title="enum serde_json::value::Value">Value</a></code><a class='srclink' href='../../src/serde_json/value/index.rs.html#111-113' title='goto source code'>[src]</a></h4></div><h3 id='impl-Index-for-%26%27a%20T' class='impl'><code class='in-band'>impl<'a, T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> <a class="trait" href="../../serde_json/value/trait.Index.html" title="trait serde_json::value::Index">Index</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a </a>T <span class="where fmt-newline">where<br> T: <a class="trait" href="../../serde_json/value/trait.Index.html" title="trait serde_json::value::Index">Index</a>, </span></code><a href='#impl-Index-for-%26%27a%20T' class='anchor'></a><a class='srclink' href='../../src/serde_json/value/index.rs.html#116-129' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.index_into-3' class="method hidden"><code id='index_into.v-3'>fn <a href='#method.index_into' class='fnname'>index_into</a><'v>(&self, v: &'v <a class="enum" href="../../serde_json/value/enum.Value.html" title="enum serde_json::value::Value">Value</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&'v <a class="enum" href="../../serde_json/value/enum.Value.html" title="enum serde_json::value::Value">Value</a>></code><a class='srclink' href='../../src/serde_json/value/index.rs.html#120-122' title='goto source code'>[src]</a></h4><h4 id='method.index_into_mut-3' class="method hidden"><code id='index_into_mut.v-3'>fn <a href='#method.index_into_mut' class='fnname'>index_into_mut</a><'v>(&self, v: &'v mut <a class="enum" href="../../serde_json/value/enum.Value.html" title="enum serde_json::value::Value">Value</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&'v mut <a class="enum" href="../../serde_json/value/enum.Value.html" title="enum serde_json::value::Value">Value</a>></code><a class='srclink' href='../../src/serde_json/value/index.rs.html#123-125' title='goto source code'>[src]</a></h4><h4 id='method.index_or_insert-3' class="method hidden"><code id='index_or_insert.v-3'>fn <a href='#method.index_or_insert' class='fnname'>index_or_insert</a><'v>(&self, v: &'v mut <a class="enum" href="../../serde_json/value/enum.Value.html" title="enum serde_json::value::Value">Value</a>) -> &'v mut <a class="enum" href="../../serde_json/value/enum.Value.html" title="enum serde_json::value::Value">Value</a></code><a class='srclink' href='../../src/serde_json/value/index.rs.html#126-128' title='goto source code'>[src]</a></h4></div><span class='loading-content'>Loading content...</span>
|
||
<h2 id='implementors' class='small-section-header'>Implementors<a href='#implementors' class='anchor'></a></h2><div class='item-list' id='implementors-list'></div><span class='loading-content'>Loading content...</span><script type="text/javascript" src="../../implementors/serde_json/value/trait.Index.js" async></script></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../../";window.currentCrate = "serde_json";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |