macro.json.html 6.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041
  1. <!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."><meta name="keywords" content="rust, rustlang, rust-lang, json"><title>json in dim_utils - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceSerif4-Regular-1f7d512b176f0f72.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/SourceSerif4-Bold-124a1ca42af929b6.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-93196c7a1c3542a8.css" id="mainThemeStyle"><link rel="stylesheet" id="themeStyle" href="../static.files/light-4743e13df3dfe8c4.css"><link rel="stylesheet" disabled href="../static.files/dark-0e1b889528bd466b.css"><link rel="stylesheet" disabled href="../static.files/ayu-65289d5d067c7c66.css"><script id="default-settings" ></script><script src="../static.files/storage-d43fa987303ecbbb.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-3367e395607fafc1.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-13285aec31fa243e.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><a class="logo-container" href="../dim_utils/index.html"><img class="rust-logo" src="../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><h2></h2></nav><nav class="sidebar"><a class="logo-container" href="../dim_utils/index.html"><img class="rust-logo" src="../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><div class="sidebar-elems"><h2><a href="index.html">In dim_utils</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><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" title="help" tabindex="-1"><a href="../help.html">?</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-5ec35bf9ca753509.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Macro <a href="index.html">dim_utils</a>::<wbr><a class="macro" href="#">json</a><button id="copy-path" onclick="copy_path(this)" 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="srclink" href="../src/dim_utils/lib.rs.html#134-139">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><div class="item-decl"><div class="example-wrap"><pre class="rust macro"><code><span class="macro">macro_rules! </span>json {
  2. ($(<span class="macro-nonterminal">$json</span>:tt)+) =&gt; { ... };
  3. }</code></pre></div>
  4. </div><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>
  5. <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>value = <span class="macro">json!</span>({
  6. <span class="string">&quot;code&quot;</span>: <span class="number">200</span>,
  7. <span class="string">&quot;success&quot;</span>: <span class="bool-val">true</span>,
  8. <span class="string">&quot;payload&quot;</span>: {
  9. <span class="string">&quot;features&quot;</span>: [
  10. <span class="string">&quot;serde&quot;</span>,
  11. <span class="string">&quot;json&quot;
  12. </span>]
  13. }
  14. });</code></pre></div>
  15. <p>Variables or expressions can be interpolated into the JSON literal. Any type
  16. interpolated into an array element or object value must implement Serde’s
  17. <code>Serialize</code> trait, while any type interpolated into a object key must
  18. implement <code>Into&lt;String&gt;</code>. If the <code>Serialize</code> implementation of the
  19. interpolated type decides to fail, or if the interpolated type contains a
  20. map with non-string keys, the <code>json!</code> macro will panic.</p>
  21. <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>code = <span class="number">200</span>;
  22. <span class="kw">let </span>features = <span class="macro">vec!</span>[<span class="string">&quot;serde&quot;</span>, <span class="string">&quot;json&quot;</span>];
  23. <span class="kw">let </span>value = <span class="macro">json!</span>({
  24. <span class="string">&quot;code&quot;</span>: code,
  25. <span class="string">&quot;success&quot;</span>: code == <span class="number">200</span>,
  26. <span class="string">&quot;payload&quot;</span>: {
  27. features[<span class="number">0</span>]: features[<span class="number">1</span>]
  28. }
  29. });</code></pre></div>
  30. <p>Trailing commas are allowed inside both arrays and objects.</p>
  31. <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>value = <span class="macro">json!</span>([
  32. <span class="string">&quot;notice&quot;</span>,
  33. <span class="string">&quot;the&quot;</span>,
  34. <span class="string">&quot;trailing&quot;</span>,
  35. <span class="string">&quot;comma --&gt;&quot;</span>,
  36. ]);</code></pre></div>
  37. </div></details></section></div></main><div id="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="dim_utils" data-themes="" data-resource-suffix="" data-rustdoc-version="1.68.2 (9eb3afe9e 2023-03-27)" data-search-js="search-98d53477a794af0b.js" data-settings-js="settings-c3c521c753752a1a.js" data-settings-css="settings-08ddfdda51b8ee2e.css" ></div></body></html>