Files
google-apis-rs/serde_json/value/trait.Index.html
2024-03-05 21:06:01 +01:00

20 lines
8.2 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-ac92e1bbe349e143.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.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-feafe1bb7466e4bd.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.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">&#9776;</button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../serde_json/index.html">serde_json</a><span class="version">1.0.107</span></h2></div><h2 class="location"><a href="#">Index</a></h2><div class="sidebar-elems"><section><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-Index-for-%26T">&amp;&#x27;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><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In serde_json::value</a></h2></div></nav><div class="sidebar-resizer"></div>
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../serde_json/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press S to search, ? for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>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" title="Copy item path to clipboard"><img src="../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../../src/serde_json/value/index.rs.html#37-52">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></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">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>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.76.0/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.76.0/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.76.0/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;'a, 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.76.0/std/primitive.reference.html">&amp;'a T</a><div class="where">where
T: ?<a class="trait" href="https://doc.rust-lang.org/1.76.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>,</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>