Files

15 lines
29 KiB
HTML
Raw Permalink Normal View History

2023-01-30 23:51:12 +00:00
<!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="BER-TLV encoder."><meta name="keywords" content="rust, rustlang, rust-lang, Encoder"><title>Encoder in flexiber - 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-6827029ac823cab7.css" id="mainThemeStyle"><link rel="stylesheet" id="themeStyle" href="../static.files/light-ebce58d0a40c3431.css"><link rel="stylesheet" disabled href="../static.files/dark-f23faae4a2daf9a6.css"><link rel="stylesheet" disabled href="../static.files/ayu-8af5e100b21cd173.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-c55e1eb52e1886b4.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 struct"><!--[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="sidebar-logo" href="../flexiber/index.html"><div class="logo-container"><img class="rust-logo" src="../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../flexiber/index.html"><div class="logo-container"><img class="rust-logo" src="../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></div></a><h2 class="location"><a href="#">Encoder</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block"><li><a href="#method.encode">encode</a></li><li><a href="#method.encode_tagged_collection">encode_tagged_collection</a></li><li><a href="#method.encode_untagged_collection">encode_untagged_collection</a></li><li><a href="#method.error">error</a></li><li><a href="#method.finish">finish</a></li><li><a href="#method.is_failed">is_failed</a></li><li><a href="#method.new">new</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block"><li><a href="#impl-Debug-for-Encoder%3C%27a%3E">Debug</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><li><a href="#impl-RefUnwindSafe-for-Encoder%3C%27a%3E">RefUnwindSafe</a></li><li><a href="#impl-Send-for-Encoder%3C%27a%3E">Send</a></li><li><a href="#impl-Sync-for-Encoder%3C%27a%3E">Sync</a></li><li><a href="#impl-Unpin-for-Encoder%3C%27a%3E">Unpin</a></li><li><a href="#impl-UnwindSafe-for-Encoder%3C%27a%3E">!UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-Encoder%3C%27a%3E">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-Encoder%3C%27a
</div></details><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor">§</a></h2><div id="implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Encoder%3C%27a%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/flexiber/encoder.rs.html#14-152">source</a><a href="#impl-Encoder%3C%27a%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'a&gt; <a class="struct" href="struct.Encoder.html" title="struct flexiber::Encoder">Encoder</a>&lt;'a&gt;</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.new" class="method has-srclink"><a class="srclink rightside" href="../src/flexiber/encoder.rs.html#16-21">source</a><h4 class="code-header">pub fn <a href="#method.new" class="fn">new</a>(bytes: &amp;'a mut [<a class="primitive" href="https://doc.rust-lang.org/1.67.0/core/primitive.u8.html">u8</a>]) -&gt; Self</h4></section></summary><div class="docblock"><p>Create a new encoder with the given byte slice as a backing buffer.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.encode" class="method has-srclink"><a class="srclink rightside" href="../src/flexiber/encoder.rs.html#24-33">source</a><h4 class="code-header">pub fn <a href="#method.encode" class="fn">encode</a>&lt;T:&nbsp;<a class="trait" href="trait.Encodable.html" title="trait flexiber::Encodable">Encodable</a>&gt;(&amp;mut self, encodable: <a class="primitive" href="https://doc.rust-lang.org/1.67.0/core/primitive.reference.html">&amp;</a>T) -&gt; <a class="type" href="type.Result.html" title="type flexiber::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.67.0/core/primitive.unit.html">()</a>&gt;</h4></section></summary><div class="docblock"><p>Encode a value which impls the <a href="trait.Encodable.html" title="Encodable"><code>Encodable</code></a> trait.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.error" class="method has-srclink"><a class="srclink rightside" href="../src/flexiber/encoder.rs.html#37-40">source</a><h4 class="code-header">pub fn <a href="#method.error" class="fn">error</a>&lt;T&gt;(&amp;mut self, kind: <a class="enum" href="enum.ErrorKind.html" title="enum flexiber::ErrorKind">ErrorKind</a>) -&gt; <a class="type" href="type.Result.html" title="type flexiber::Result">Result</a>&lt;T&gt;</h4></section></summary><div class="docblock"><p>Return an error with the given <a href="enum.ErrorKind.html" title="ErrorKind"><code>ErrorKind</code></a>, annotating it with
2021-04-25 15:21:05 +00:00
context about where the error occurred.</p>
2023-01-30 23:51:12 +00:00
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.is_failed" class="method has-srclink"><a class="srclink rightside" href="../src/flexiber/encoder.rs.html#43-45">source</a><h4 class="code-header">pub fn <a href="#method.is_failed" class="fn">is_failed</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.67.0/core/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Did the decoding operation fail due to an error?</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.finish" class="method has-srclink"><a class="srclink rightside" href="../src/flexiber/encoder.rs.html#49-58">source</a><h4 class="code-header">pub fn <a href="#method.finish" class="fn">finish</a>(self) -&gt; <a class="type" href="type.Result.html" title="type flexiber::Result">Result</a>&lt;&amp;'a [<a class="primitive" href="https://doc.rust-lang.org/1.67.0/core/primitive.u8.html">u8</a>]&gt;</h4></section></summary><div class="docblock"><p>Finish encoding to the buffer, returning a slice containing the data
2021-04-25 15:21:05 +00:00
written to the buffer.</p>
2023-01-30 23:51:12 +00:00
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.encode_tagged_collection" class="method has-srclink"><a class="srclink rightside" href="../src/flexiber/encoder.rs.html#61-76">source</a><h4 class="code-header">pub fn <a href="#method.encode_tagged_collection" class="fn">encode_tagged_collection</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self,<br>&nbsp;&nbsp;&nbsp;&nbsp;tag: <a class="struct" href="struct.Tag.html" title="struct flexiber::Tag">Tag</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;encodables: &amp;[&amp;dyn <a class="trait" href="trait.Encodable.html" title="trait flexiber::Encodable">Encodable</a>]<br>) -&gt; <a class="type" href="type.Result.html" title="type flexiber::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.67.0/core/primitive.unit.html">()</a>&gt;</h4></section></summary><div class="docblock"><p>Encode a collection of values which impl the <a href="trait.Encodable.html" title="Encodable"><code>Encodable</code></a> trait under a given tag.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.encode_untagged_collection" class="method has-srclink"><a class="srclink rightside" href="../src/flexiber/encoder.rs.html#79-87">source</a><h4 class="code-header">pub fn <a href="#method.encode_untagged_collection" class="fn">encode_untagged_collection</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self,<br>&nbsp;&nbsp;&nbsp;&nbsp;encodables: &amp;[&amp;dyn <a class="trait" href="trait.Encodable.html" title="trait flexiber::Encodable">Encodable</a>]<br>) -&gt; <a class="type" href="type.Result.html" title="type flexiber::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.67.0/core/primitive.unit.html">()</a>&gt;</h4></section></summary><div class="docblock"><p>Encode a collection of values which impl the <a href="trait.Encodable.html" title="Encodable"><code>Encodable</code></a> trait under a given tag.</p>
</div></details></div></details></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor">§</a></h2><div id="trait-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Debug-for-Encoder%3C%27a%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/flexiber/encoder.rs.html#5">source</a><a href="#impl-Debug-for-Encoder%3C%27a%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'a&gt; <a class="trait" href="https://doc.rust-lang.org/1.67.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="struct.Encoder.html" title="struct flexiber::Encoder">Encoder</a>&lt;'a&gt;</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/flexiber/encoder.rs.html#5">source</a><a href="#method.fmt" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.67.0/core/fmt/trait.Debug.html#tymethod.fmt" class="fn">fmt</a>(&amp;self, f: &amp;mut <a class="struct" href="https://doc.rust-lang.org/1.67.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>&lt;'_&gt;) -&gt; <a class="type" href="https://doc.rust-lang.org/1.67.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/1.67.0/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></div></details></div></details></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor">§</a></h2><div id="synthetic-implementations-list"><section id="impl-RefUnwindSafe-for-Encoder%3C%27a%3E" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-Encoder%3C%27a%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'a&gt; <a class="trait" href="https://doc.rust-lang.org/1.67.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.Encoder.html" title="struct flexiber::Encoder">Encoder</a>&lt;'a&gt;</h3></section><section id="impl-Send-for-Encoder%3C%27a%3E" class="impl has-srclink"><a href="#impl-Send-for-Encoder%3C%27a%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'a&gt; <a class="trait" href="https://doc.rust-lang.org/1.67.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.Encoder.html" title="struct flexiber::Encoder">Encoder</a>&lt;'a&gt;</h3></section><section id="impl-Sync-for-Encoder%3C%27a%3E" class="impl has-srclink"><a href="#impl-Sync-for-Encoder%3C%27a%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'a&gt; <a class="trait" href="https://doc.rust-lang.org/1.67.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.Encoder.html" title="struct flexiber::Encoder">Encoder</a>&lt;'a&gt;</h3></section><section id="impl-Unpin-for-Encoder%3C%27a%3E" class="impl has-srclink"><a href="#impl-Unpin-for-Encoder%3C%27a%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'a&gt; <a class="trait" href="https://doc.rust-lang.org/1.67.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.Encoder.html" title="struct flexiber::Encoder">Encoder</a>&lt;'a&gt;</h3></section><section id="impl-UnwindSafe-for-Encoder%3C%27a%3E" class="impl has-srclink"><a href="#impl-UnwindSafe-for-Encoder%3C%27a%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'a&gt; !<a class="trait" href="https://doc.rust-lang.org/1.67.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.Encoder.html" title="struct flexiber::Encoder">E
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-Encoder%3C%27a%3E" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/1.67.0/src/core/convert/mod.rs.html#717">source</a><a href="#impl-Into%3CU%3E-for-Encoder%3C%27a%3E" class="anchor">§</a><h3 class="code-header">impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/1.67.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;U&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: <a class="trait" href="https://doc.rust-lang.org/1.67.0/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt;,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/1.67.0/src/core/convert/mod.rs.html#725">source</a></span><a href="#method.into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.67.0/core/convert/trait.Into.html#tymethod.into" class="fn">into</a>(self) -&gt; U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p>
<p>That is, this conversion is whatever the implementation of
<code><a href="https://doc.rust-lang.org/1.67.0/core/convert/trait.From.html" title="From">From</a>&lt;T&gt; for U</code> chooses to do.</p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-Encoder%3C%27a%3E" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/1.67.0/src/core/convert/mod.rs.html#775">source</a><a href="#impl-TryFrom%3CU%3E-for-Encoder%3C%27a%3E" class="anchor">§</a><h3 class="code-header">impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/1.67.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;U&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: <a class="trait" href="https://doc.rust-lang.org/1.67.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;T&gt;,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.67.0/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.67.0/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/1.67.0/src/core/convert/mod.rs.html#781">source</a></span><a href="#method.try_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.67.0/core/convert/trait.TryFrom.html#tymethod.try_from" class="fn">try_from</a>(value: U) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.67.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, &lt;T as <a class="trait" href="https://doc.rust-lang.org/1.67.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;U&gt;&gt;::<a class="associatedtype" href="https://doc.rust-lang.org/1.67.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>&gt;</h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-Encoder%3C%27a%3E" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/1.67.0/src/core/convert/mod.rs.html#760">source</a><a href="#impl-TryInto%3CU%3E-for-Encoder%3C%27a%3E" class="anchor">§</a><h3 class="code-header">impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/1.67.0/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a>&lt;U&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: <a class="trait" href="https://doc.rust-lang.org/1.67.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.67.0/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = &lt;U as <a class="trait" href="https://doc.rust-lang.org/1.67.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;&gt;::<a class="associatedtype" href="https://doc.rust-lang.org/1.67.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</