difftastic/rustdoc/serde_json/macro.json.html

42 lines
6.1 KiB
HTML

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

<!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="Construct a `serde_json::Value` from a JSON literal."><title>json in serde_json - 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 macro"><!--[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.145</span></h2></div><div class="sidebar-elems"></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>Macro <a href="index.html">serde_json</a>::<wbr><a class="macro" href="#">json</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/macros.rs.html#54-59">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><span class="macro">macro_rules! </span>json {
($(<span class="macro-nonterminal">$json</span>:tt)+) =&gt; { ... };
}</pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Construct a <code>serde_json::Value</code> from a JSON literal.</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>value = <span class="macro">json!</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>],
<span class="string">"homepage"</span>: null
}
});</code></pre></div>
<p>Variables or expressions can be interpolated into the JSON literal. Any type
interpolated into an array element or object value must implement Serdes
<code>Serialize</code> trait, while any type interpolated into a object key must
implement <code>Into&lt;String&gt;</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>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>code = <span class="number">200</span>;
<span class="kw">let </span>features = <span class="macro">vec!</span>[<span class="string">"serde"</span>, <span class="string">"json"</span>];
<span class="kw">let </span>value = <span class="macro">json!</span>({
<span class="string">"code"</span>: code,
<span class="string">"success"</span>: code == <span class="number">200</span>,
<span class="string">"payload"</span>: {
features[<span class="number">0</span>]: features[<span class="number">1</span>]
}
});</code></pre></div>
<p>Trailing commas are allowed inside both arrays and objects.</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>value = <span class="macro">json!</span>([
<span class="string">"notice"</span>,
<span class="string">"the"</span>,
<span class="string">"trailing"</span>,
<span class="string">"comma --&gt;"</span>,
]);</code></pre></div>
</div></details></section></div></main></body></html>