mirror of
https://github.com/quickwit-oss/tantivy.git
synced 2026-05-21 02:30:43 +00:00
45 lines
6.5 KiB
HTML
45 lines
6.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="API documentation for the Rust `json` macro in crate `serde_json`."><meta name="keywords" content="rust, rustlang, rust-lang, json"><title>serde_json::json - 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></head><body class="rustdoc macro"><!--[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><div class="sidebar-elems"><p class='location'><a href='index.html'>serde_json</a></p><script>window.sidebarCurrent = {name: 'json', ty: 'macro', 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 js-only"><div class="search-container"><input class="search-input" name="search" autocomplete="off" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><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='in-band'>Macro <a href='index.html'>serde_json</a>::<wbr><a class="macro" href=''>json</a></span><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/macros.rs.html#70-75' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class="rust macro">
|
||
<span class="macro">macro_rules</span><span class="macro">!</span> <span class="ident">json</span> {
|
||
($(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">json</span>:<span class="ident">tt</span>)<span class="op">+</span>) <span class="op">=></span> { ... };
|
||
}</pre>
|
||
</div><div class='docblock'><p>Construct a <code>serde_json::Value</code> from a JSON literal.</p>
|
||
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="ident">value</span> <span class="op">=</span> <span class="macro">json</span><span class="macro">!</span>({
|
||
<span class="string">"code"</span>: <span class="number">200</span>,
|
||
<span class="string">"success"</span>: <span class="bool-val">true</span>,
|
||
<span class="string">"payload"</span>: {
|
||
<span class="string">"features"</span>: [
|
||
<span class="string">"serde"</span>,
|
||
<span class="string">"json"</span>
|
||
]
|
||
}
|
||
});</pre>
|
||
<p>Variables or expressions can be interpolated into the JSON literal. Any type
|
||
interpolated into an array element or object value must implement Serde's
|
||
<code>Serialize</code> trait, while any type interpolated into a object key must
|
||
implement <code>Into<String></code>. If the <code>Serialize</code> implementation of the
|
||
interpolated type decides to fail, or if the interpolated type contains a
|
||
map with non-string keys, the <code>json!</code> macro will panic.</p>
|
||
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="ident">code</span> <span class="op">=</span> <span class="number">200</span>;
|
||
<span class="kw">let</span> <span class="ident">features</span> <span class="op">=</span> <span class="macro">vec</span><span class="macro">!</span>[<span class="string">"serde"</span>, <span class="string">"json"</span>];
|
||
|
||
<span class="kw">let</span> <span class="ident">value</span> <span class="op">=</span> <span class="macro">json</span><span class="macro">!</span>({
|
||
<span class="string">"code"</span>: <span class="ident">code</span>,
|
||
<span class="string">"success"</span>: <span class="ident">code</span> <span class="op">==</span> <span class="number">200</span>,
|
||
<span class="string">"payload"</span>: {
|
||
<span class="ident">features</span>[<span class="number">0</span>]: <span class="ident">features</span>[<span class="number">1</span>]
|
||
}
|
||
});</pre>
|
||
<p>Trailing commas are allowed inside both arrays and objects.</p>
|
||
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="ident">value</span> <span class="op">=</span> <span class="macro">json</span><span class="macro">!</span>([
|
||
<span class="string">"notice"</span>,
|
||
<span class="string">"the"</span>,
|
||
<span class="string">"trailing"</span>,
|
||
<span class="string">"comma -->"</span>,
|
||
]);</pre>
|
||
</div></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g. <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g. <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><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> |