mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-25 12:44:07 +01:00
43 lines
7.2 KiB
HTML
43 lines
7.2 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="Serialize value by using it’s `Display` implementation"><title>SerializeDisplay in serde_with_macros - 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_with_macros" 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 derive"><!--[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">☰</button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../serde_with_macros/index.html">serde_with_macros</a><span class="version">2.3.3</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_with_macros/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>Derive Macro <a href="index.html">serde_with_macros</a>::<wbr><a class="derive" href="#">SerializeDisplay</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_with_macros/lib.rs.html#1134-1146">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>#[derive(SerializeDisplay)]
|
||
{
|
||
<span class="comment">// Attributes available to this derive:</span>
|
||
#[serde_with]
|
||
}
|
||
</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Serialize value by using it’s <a href="https://doc.rust-lang.org/1.76.0/core/fmt/trait.Display.html" title="trait core::fmt::Display"><code>Display</code></a> implementation</p>
|
||
<p>This is an alternative way to implement <code>Serialize</code> for types, which also implement <a href="https://doc.rust-lang.org/1.76.0/core/fmt/trait.Display.html" title="trait core::fmt::Display"><code>Display</code></a>
|
||
by serializing the type as string. Ensure that the struct/enum also implements <a href="https://doc.rust-lang.org/1.76.0/core/fmt/trait.Display.html" title="trait core::fmt::Display"><code>Display</code></a>.
|
||
If the implementation is missing, you will get an error message like</p>
|
||
<div class="example-wrap"><pre class="language-text"><code>error[E0277]: `Struct` doesn't implement `std::fmt::Display`
|
||
</code></pre></div>
|
||
<p>Deserialization with <a href="https://doc.rust-lang.org/1.76.0/core/str/traits/trait.FromStr.html" title="trait core::str::traits::FromStr"><code>FromStr</code></a> is available with the matching <a href="derive.DeserializeFromStr.html" title="derive serde_with_macros::DeserializeFromStr"><code>DeserializeFromStr</code></a> derive.</p>
|
||
<h2 id="attributes"><a href="#attributes">Attributes</a></h2>
|
||
<p>Attributes for the derive can be specified via the <code>#[serde_with(...)]</code> attribute on the struct
|
||
or enum. Currently, these arguments to the attribute are possible:</p>
|
||
<ul>
|
||
<li>
|
||
<p><strong><code>#[serde_with(crate = "...")]</code></strong>: This allows using <code>SerializeDisplay</code> when <code>serde_with</code> is
|
||
not available from the crate root. This happens while <a href="https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#renaming-dependencies-in-cargotoml">renaming dependencies in
|
||
Cargo.toml</a> or when re-exporting the macro from a different crate.</p>
|
||
<p>This argument is analogue to <a href="https://serde.rs/container-attrs.html#crate">serde’s crate argument</a> and the <a href="https://docs.rs/serde_with/2.3.3/serde_with/guide/serde_as/index.html#re-exporting-serde_as">crate argument
|
||
to <code>serde_as</code></a>.</p>
|
||
</li>
|
||
</ul>
|
||
<h2 id="example"><a href="#example">Example</a></h2>
|
||
<div class="example-wrap ignore"><a href="#" class="tooltip" title="This example is not tested">ⓘ</a><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::fmt;
|
||
|
||
<span class="attr">#[derive(SerializeDisplay)]
|
||
</span><span class="kw">struct </span>A {
|
||
a: u32,
|
||
b: bool,
|
||
}
|
||
|
||
<span class="kw">impl </span>fmt::Display <span class="kw">for </span>A {
|
||
<span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter<<span class="lifetime">'_</span>>) -> fmt::Result {
|
||
<span class="macro">write!</span>(f, <span class="string">"{}<>{}"</span>, <span class="self">self</span>.a, <span class="self">self</span>.b)
|
||
}
|
||
}
|
||
|
||
<span class="kw">let </span>a = A { a: <span class="number">123</span>, b: <span class="bool-val">false </span>};
|
||
<span class="macro">assert_eq!</span>(<span class="string">r#""123<>false""#</span>, serde_json::to_string(<span class="kw-2">&</span>a).unwrap());</code></pre></div>
|
||
</div></details></section></div></main></body></html> |