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="Returned from `Serializer::serialize_map`."><title>SerializeMap in bdk_chain::bitcoin::hashes::serde::ser - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../../../../static.files/rustdoc-dd39b87e5fcfba68.css"><meta name="rustdoc-vars" data-root-path="../../../../../" data-static-root-path="../../../../../static.files/" data-current-crate="bdk_chain" data-themes="" data-resource-suffix="" data-rustdoc-version="1.80.0-nightly (78a775127 2024-05-11)" data-channel="nightly" data-search-js="search-d52510db62a78183.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../../../../static.files/storage-118b08c4c78b968e.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../../../../static.files/main-20a3ad099b048cf2.js"></script><noscript><link rel="stylesheet" href="../../../../../static.files/noscript-df360f571f6edeae.css"></noscript><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" title="show sidebar"></button><a class="logo-container" href="../../../../../bdk_chain/index.html"><img src="https://github.com/bitcoindevkit/bdk/raw/master/static/bdk.png" alt=""></a></nav><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../../../../../bdk_chain/index.html"><img src="https://github.com/bitcoindevkit/bdk/raw/master/static/bdk.png" alt="logo"></a><h2><a href="../../../../../bdk_chain/index.html">bdk_chain</a><span class="version">0.18.0</span></h2></div><h2 class="location"><a href="#">SerializeMap</a></h2><div class="sidebar-elems"><section><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.Error">Error</a></li><li><a href="#associatedtype.Ok">Ok</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.end">end</a></li><li><a href="#tymethod.serialize_key">serialize_key</a></li><li><a href="#tymethod.serialize_value">serialize_value</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.serialize_entry">serialize_entry</a></li></ul><h3><a href="#object-safety">Object Safety</a></h3><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In bdk_chain::bitcoin::hashes::serde::ser</a></h2></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Trait <a href="../../../../index.html">bdk_chain</a>::<wbr><a href="../../../index.html">bitcoin</a>::<wbr><a href="../../index.html">hashes</a>::<wbr><a href="../index.html">serde</a>::<wbr><a href="index.html">ser</a>::<wbr><a class="trait" href="#">SerializeMap</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="https://docs.rs/serde/1.0.209/src/serde/ser/mod.rs.html#1767">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub trait SerializeMap {
2 type <a href="#associatedtype.Ok" class="associatedtype">Ok</a>;
3 type <a href="#associatedtype.Error" class="associatedtype">Error</a>: <a class="trait" href="trait.Error.html" title="trait bdk_chain::bitcoin::hashes::serde::ser::Error">Error</a>;
6 fn <a href="#tymethod.serialize_key" class="fn">serialize_key</a><T>(&mut self, key: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&T</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="trait.SerializeMap.html#associatedtype.Error" title="type bdk_chain::bitcoin::hashes::serde::ser::SerializeMap::Error">Error</a>>
7 <span class="where">where T: <a class="trait" href="../trait.Serialize.html" title="trait bdk_chain::bitcoin::hashes::serde::Serialize">Serialize</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a></span>;
8 <span class="item-spacer"></span> fn <a href="#tymethod.serialize_value" class="fn">serialize_value</a><T>(&mut self, value: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&T</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="trait.SerializeMap.html#associatedtype.Error" title="type bdk_chain::bitcoin::hashes::serde::ser::SerializeMap::Error">Error</a>>
9 <span class="where">where T: <a class="trait" href="../trait.Serialize.html" title="trait bdk_chain::bitcoin::hashes::serde::Serialize">Serialize</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a></span>;
10 <span class="item-spacer"></span> fn <a href="#tymethod.end" class="fn">end</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self::<a class="associatedtype" href="trait.SerializeMap.html#associatedtype.Ok" title="type bdk_chain::bitcoin::hashes::serde::ser::SerializeMap::Ok">Ok</a>, Self::<a class="associatedtype" href="trait.SerializeMap.html#associatedtype.Error" title="type bdk_chain::bitcoin::hashes::serde::ser::SerializeMap::Error">Error</a>>;
13 fn <a href="#method.serialize_entry" class="fn">serialize_entry</a><K, V>(
15 key: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&K</a>,
16 value: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&V</a>
17 ) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="trait.SerializeMap.html#associatedtype.Error" title="type bdk_chain::bitcoin::hashes::serde::ser::SerializeMap::Error">Error</a>>
18 <span class="where">where K: <a class="trait" href="../trait.Serialize.html" title="trait bdk_chain::bitcoin::hashes::serde::Serialize">Serialize</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,
19 V: <a class="trait" href="../trait.Serialize.html" title="trait bdk_chain::bitcoin::hashes::serde::Serialize">Serialize</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a></span> { ... }
20 }</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Returned from <code>Serializer::serialize_map</code>.</p>
21 <h2 id="example-use"><a class="doc-anchor" href="#example-use">§</a>Example use</h2>
22 <div class="example-wrap edition"><a href="#" class="tooltip" title="This example runs with edition 2021">ⓘ</a><pre class="rust rust-example-rendered"><code><span class="kw">use </span>serde::ser::{Serialize, SerializeMap, Serializer};
24 <span class="kw">impl</span><K, V> Serialize <span class="kw">for </span>HashMap<K, V>
25 <span class="kw">where
29 <span class="kw">fn </span>serialize<S>(<span class="kw-2">&</span><span class="self">self</span>, serializer: S) -> <span class="prelude-ty">Result</span><S::Ok, S::Error>
30 <span class="kw">where
33 <span class="kw">let </span><span class="kw-2">mut </span>map = serializer.serialize_map(<span class="prelude-val">Some</span>(<span class="self">self</span>.len()))<span class="question-mark">?</span>;
34 <span class="kw">for </span>(k, v) <span class="kw">in </span><span class="self">self </span>{
35 map.serialize_entry(k, v)<span class="question-mark">?</span>;
40 <h2 id="example-implementation"><a class="doc-anchor" href="#example-implementation">§</a>Example implementation</h2>
41 <p>The <a href="https://serde.rs/data-format.html">example data format</a> presented on the website demonstrates an
42 implementation of <code>SerializeMap</code> for a basic JSON data format.</p>
43 </div></details><h2 id="required-associated-types" class="section-header">Required Associated Types<a href="#required-associated-types" class="anchor">§</a></h2><div class="methods"><details class="toggle" open><summary><section id="associatedtype.Ok" class="method"><a class="src rightside" href="https://docs.rs/serde/1.0.209/src/serde/ser/mod.rs.html#1769">source</a><h4 class="code-header">type <a href="#associatedtype.Ok" class="associatedtype">Ok</a></h4></section></summary><div class="docblock"><p>Must match the <code>Ok</code> type of our <code>Serializer</code>.</p>
44 </div></details><details class="toggle" open><summary><section id="associatedtype.Error" class="method"><a class="src rightside" href="https://docs.rs/serde/1.0.209/src/serde/ser/mod.rs.html#1772">source</a><h4 class="code-header">type <a href="#associatedtype.Error" class="associatedtype">Error</a>: <a class="trait" href="trait.Error.html" title="trait bdk_chain::bitcoin::hashes::serde::ser::Error">Error</a></h4></section></summary><div class="docblock"><p>Must match the <code>Error</code> type of our <code>Serializer</code>.</p>
45 </div></details></div><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.serialize_key" class="method"><a class="src rightside" href="https://docs.rs/serde/1.0.209/src/serde/ser/mod.rs.html#1780-1782">source</a><h4 class="code-header">fn <a href="#tymethod.serialize_key" class="fn">serialize_key</a><T>(&mut self, key: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&T</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="trait.SerializeMap.html#associatedtype.Error" title="type bdk_chain::bitcoin::hashes::serde::ser::SerializeMap::Error">Error</a>><div class="where">where
46 T: <a class="trait" href="../trait.Serialize.html" title="trait bdk_chain::bitcoin::hashes::serde::Serialize">Serialize</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class="docblock"><p>Serialize a map key.</p>
47 <p>If possible, <code>Serialize</code> implementations are encouraged to use
48 <code>serialize_entry</code> instead as it may be implemented more efficiently in
49 some formats compared to a pair of calls to <code>serialize_key</code> and
50 <code>serialize_value</code>.</p>
51 </div></details><details class="toggle method-toggle" open><summary><section id="tymethod.serialize_value" class="method"><a class="src rightside" href="https://docs.rs/serde/1.0.209/src/serde/ser/mod.rs.html#1790-1792">source</a><h4 class="code-header">fn <a href="#tymethod.serialize_value" class="fn">serialize_value</a><T>(&mut self, value: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&T</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="trait.SerializeMap.html#associatedtype.Error" title="type bdk_chain::bitcoin::hashes::serde::ser::SerializeMap::Error">Error</a>><div class="where">where
52 T: <a class="trait" href="../trait.Serialize.html" title="trait bdk_chain::bitcoin::hashes::serde::Serialize">Serialize</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class="docblock"><p>Serialize a map value.</p>
53 <h5 id="panics"><a class="doc-anchor" href="#panics">§</a>Panics</h5>
54 <p>Calling <code>serialize_value</code> before <code>serialize_key</code> is incorrect and is
55 allowed to panic or produce bogus results.</p>
56 </div></details><details class="toggle method-toggle" open><summary><section id="tymethod.end" class="method"><a class="src rightside" href="https://docs.rs/serde/1.0.209/src/serde/ser/mod.rs.html#1821">source</a><h4 class="code-header">fn <a href="#tymethod.end" class="fn">end</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self::<a class="associatedtype" href="trait.SerializeMap.html#associatedtype.Ok" title="type bdk_chain::bitcoin::hashes::serde::ser::SerializeMap::Ok">Ok</a>, Self::<a class="associatedtype" href="trait.SerializeMap.html#associatedtype.Error" title="type bdk_chain::bitcoin::hashes::serde::ser::SerializeMap::Error">Error</a>></h4></section></summary><div class="docblock"><p>Finish serializing a map.</p>
57 </div></details></div><h2 id="provided-methods" class="section-header">Provided Methods<a href="#provided-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="method.serialize_entry" class="method"><a class="src rightside" href="https://docs.rs/serde/1.0.209/src/serde/ser/mod.rs.html#1811-1814">source</a><h4 class="code-header">fn <a href="#method.serialize_entry" class="fn">serialize_entry</a><K, V>(
59 key: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&K</a>,
60 value: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&V</a>
61 ) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="trait.SerializeMap.html#associatedtype.Error" title="type bdk_chain::bitcoin::hashes::serde::ser::SerializeMap::Error">Error</a>><div class="where">where
62 K: <a class="trait" href="../trait.Serialize.html" title="trait bdk_chain::bitcoin::hashes::serde::Serialize">Serialize</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,
63 V: <a class="trait" href="../trait.Serialize.html" title="trait bdk_chain::bitcoin::hashes::serde::Serialize">Serialize</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class="docblock"><p>Serialize a map entry consisting of a key and a value.</p>
64 <p>Some <a href="../trait.Serialize.html"><code>Serialize</code></a> types are not able to hold a key and value in memory
65 at the same time so <code>SerializeMap</code> implementations are required to
66 support <a href="#tymethod.serialize_key"><code>serialize_key</code></a> and <a href="#tymethod.serialize_value"><code>serialize_value</code></a> individually. The
67 <code>serialize_entry</code> method allows serializers to optimize for the case
68 where key and value are both available. <a href="../trait.Serialize.html"><code>Serialize</code></a> implementations
69 are encouraged to use <code>serialize_entry</code> if possible.</p>
70 <p>The default implementation delegates to <a href="#tymethod.serialize_key"><code>serialize_key</code></a> and
71 <a href="#tymethod.serialize_value"><code>serialize_value</code></a>. This is appropriate for serializers that do not
72 care about performance or are not able to optimize <code>serialize_entry</code> any
74 </div></details></div><h2 id="object-safety" class="section-header">Object Safety<a href="#object-safety" class="anchor">§</a></h2><div class="object-safety-info">This trait is <b>not</b> <a href="https://doc.rust-lang.org/nightly/reference/items/traits.html#object-safety">object safe</a>.</div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><details class="toggle implementors-toggle"><summary><section id="impl-SerializeMap-for-Impossible%3COk,+Error%3E" class="impl"><a class="src rightside" href="https://docs.rs/serde/1.0.209/src/serde/ser/impossible.rs.html#148-150">source</a><a href="#impl-SerializeMap-for-Impossible%3COk,+Error%3E" class="anchor">§</a><h3 class="code-header">impl<Ok, Error> <a class="trait" href="trait.SerializeMap.html" title="trait bdk_chain::bitcoin::hashes::serde::ser::SerializeMap">SerializeMap</a> for <a class="struct" href="struct.Impossible.html" title="struct bdk_chain::bitcoin::hashes::serde::ser::Impossible">Impossible</a><Ok, Error><div class="where">where
75 Error: <a class="trait" href="trait.Error.html" title="trait bdk_chain::bitcoin::hashes::serde::ser::Error">Error</a>,</div></h3></section></summary><div class="impl-items"><section id="associatedtype.Ok-1" class="associatedtype trait-impl"><a href="#associatedtype.Ok-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Ok" class="associatedtype">Ok</a> = Ok</h4></section><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Error" class="associatedtype">Error</a> = Error</h4></section></div></details></div><script src="../../../../../trait.impl/serde/ser/trait.SerializeMap.js" data-ignore-extern-crates="serde" async></script></section></div></main></body></html>
projects / bitcoindevkit.org / blob