mirror of
https://github.com/trussed-dev/flexiber.git
synced 2026-06-20 04:16:10 -07:00
deploy: 880f5beaa9
This commit is contained in:
nickray
@@ -1,11 +1,11 @@
|
||||
<!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="API documentation for the Rust `Container` trait in crate `flexiber`."><meta name="keywords" content="rust, rustlang, rust-lang, Container"><title>flexiber::Container - Rust</title><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script id="default-settings"></script><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../favicon.svg">
|
||||
<link rel="alternate icon" type="image/png" href="../favicon-16x16.png">
|
||||
<link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc trait"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../flexiber/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><p class="location">Trait Container</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.fields">fields</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class="location"><a href="index.html">flexiber</a></p><script>window.sidebarCurrent = {name: "Container", ty: "trait", relpath: ""};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||||
<a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../src/flexiber/traits.rs.html#166-176" title="goto source code">[src]</a></span><span class="in-band">Trait <a href="index.html">flexiber</a>::<wbr><a class="trait" href="">Container</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust trait">pub trait Container {
|
||||
<a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../src/flexiber/traits.rs.html#169-179" title="goto source code">[src]</a></span><span class="in-band">Trait <a href="index.html">flexiber</a>::<wbr><a class="trait" href="">Container</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust trait">pub trait Container {
|
||||
fn <a href="#tymethod.fields" class="fnname">fields</a><F, T>(&self, f: F) -> <a class="type" href="../flexiber/type.Result.html" title="type flexiber::Result">Result</a><T><br> <span class="where">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(&[&dyn <a class="trait" href="../flexiber/trait.Encodable.html" title="trait flexiber::Encodable">Encodable</a>]) -> <a class="type" href="../flexiber/type.Result.html" title="type flexiber::Result">Result</a><T></span>;
|
||||
}</pre></div><div class="docblock"><p>Multiple encodables in a container.</p>
|
||||
<p>A container implementing <code>Tagged</code> has a blanked implementation of <code>Encodable</code>.</p>
|
||||
</div><h2 id="required-methods" class="small-section-header">Required methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><h3 id="tymethod.fields" class="method"><code>fn <a href="#tymethod.fields" class="fnname">fields</a><F, T>(&self, f: F) -> <a class="type" href="../flexiber/type.Result.html" title="type flexiber::Result">Result</a><T> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(&[&dyn <a class="trait" href="../flexiber/trait.Encodable.html" title="trait flexiber::Encodable">Encodable</a>]) -> <a class="type" href="../flexiber/type.Result.html" title="type flexiber::Result">Result</a><T>, </span></code><a class="srclink" href="../src/flexiber/traits.rs.html#173-175" title="goto source code">[src]</a></h3><div class="docblock"><p>Call the provided function with a slice of <a href="../flexiber/trait.Encodable.html" title="Encodable"><code>Encodable</code></a> trait objects
|
||||
</div><h2 id="required-methods" class="small-section-header">Required methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><h3 id="tymethod.fields" class="method"><code>fn <a href="#tymethod.fields" class="fnname">fields</a><F, T>(&self, f: F) -> <a class="type" href="../flexiber/type.Result.html" title="type flexiber::Result">Result</a><T> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(&[&dyn <a class="trait" href="../flexiber/trait.Encodable.html" title="trait flexiber::Encodable">Encodable</a>]) -> <a class="type" href="../flexiber/type.Result.html" title="type flexiber::Result">Result</a><T>, </span></code><a class="srclink" href="../src/flexiber/traits.rs.html#176-178" title="goto source code">[src]</a></h3><div class="docblock"><p>Call the provided function with a slice of <a href="../flexiber/trait.Encodable.html" title="Encodable"><code>Encodable</code></a> trait objects
|
||||
representing the fields of this message.</p>
|
||||
<p>This method uses a callback because structs with fields which aren't
|
||||
directly <a href="../flexiber/trait.Encodable.html" title="Encodable"><code>Encodable</code></a> may need to construct temporary values from
|
||||
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@@ -1,9 +1,9 @@
|
||||
<!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="API documentation for the Rust `Tagged` trait in crate `flexiber`."><meta name="keywords" content="rust, rustlang, rust-lang, Tagged"><title>flexiber::Tagged - Rust</title><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script id="default-settings"></script><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../favicon.svg">
|
||||
<link rel="alternate icon" type="image/png" href="../favicon-16x16.png">
|
||||
<link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc trait"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../flexiber/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><p class="location">Trait Tagged</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.tag">tag</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class="location"><a href="index.html">flexiber</a></p><script>window.sidebarCurrent = {name: "Tagged", ty: "trait", relpath: ""};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||||
<a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../src/flexiber/traits.rs.html#158-161" title="goto source code">[src]</a></span><span class="in-band">Trait <a href="index.html">flexiber</a>::<wbr><a class="trait" href="">Tagged</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust trait">pub trait Tagged {
|
||||
<a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../src/flexiber/traits.rs.html#161-164" title="goto source code">[src]</a></span><span class="in-band">Trait <a href="index.html">flexiber</a>::<wbr><a class="trait" href="">Tagged</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust trait">pub trait Tagged {
|
||||
fn <a href="#tymethod.tag" class="fnname">tag</a>() -> <a class="struct" href="../flexiber/struct.Tag.html" title="struct flexiber::Tag">Tag</a>;
|
||||
}</pre></div><div class="docblock"><p>Types with an associated BER-TLV <a href="../flexiber/struct.Tag.html" title="Tag"><code>Tag</code></a>.</p>
|
||||
<p>A tagged type implementing <code>Container</code> has a blanked implementation of <code>Encodable</code>.</p>
|
||||
</div><h2 id="required-methods" class="small-section-header">Required methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><h3 id="tymethod.tag" class="method"><code>fn <a href="#tymethod.tag" class="fnname">tag</a>() -> <a class="struct" href="../flexiber/struct.Tag.html" title="struct flexiber::Tag">Tag</a></code><a class="srclink" href="../src/flexiber/traits.rs.html#160" title="goto source code">[src]</a></h3><div class="docblock"><p>The tag</p>
|
||||
</div><h2 id="required-methods" class="small-section-header">Required methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><h3 id="tymethod.tag" class="method"><code>fn <a href="#tymethod.tag" class="fnname">tag</a>() -> <a class="struct" href="../flexiber/struct.Tag.html" title="struct flexiber::Tag">Tag</a></code><a class="srclink" href="../src/flexiber/traits.rs.html#163" title="goto source code">[src]</a></h3><div class="docblock"><p>The tag</p>
|
||||
</div></div><span class="loading-content">Loading content...</span><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"></div><span class="loading-content">Loading content...</span><script type="text/javascript" src="../implementors/flexiber/trait.Tagged.js" async></script></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../";window.currentCrate = "flexiber";</script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>
|
||||
+1
-1
File diff suppressed because one or more lines are too long
@@ -578,6 +578,26 @@
|
||||
<span id="575">575</span>
|
||||
<span id="576">576</span>
|
||||
<span id="577">577</span>
|
||||
<span id="578">578</span>
|
||||
<span id="579">579</span>
|
||||
<span id="580">580</span>
|
||||
<span id="581">581</span>
|
||||
<span id="582">582</span>
|
||||
<span id="583">583</span>
|
||||
<span id="584">584</span>
|
||||
<span id="585">585</span>
|
||||
<span id="586">586</span>
|
||||
<span id="587">587</span>
|
||||
<span id="588">588</span>
|
||||
<span id="589">589</span>
|
||||
<span id="590">590</span>
|
||||
<span id="591">591</span>
|
||||
<span id="592">592</span>
|
||||
<span id="593">593</span>
|
||||
<span id="594">594</span>
|
||||
<span id="595">595</span>
|
||||
<span id="596">596</span>
|
||||
<span id="597">597</span>
|
||||
</pre><div class="example-wrap"><pre class="rust ">
|
||||
<span class="comment">// pub use der::{Decodable, Encodable};</span>
|
||||
<span class="doccomment">//! Trait definitions</span>
|
||||
@@ -718,6 +738,9 @@
|
||||
}
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"heapless"</span>)]</span>
|
||||
<span class="kw">impl</span><span class="op"><</span><span class="ident">X</span><span class="op">></span> <span class="ident">EncodableHeapless</span> <span class="kw">for</span> <span class="ident">X</span> <span class="kw">where</span> <span class="ident">X</span>: <span class="ident">Encodable</span> {}
|
||||
|
||||
<span class="doccomment">/// Types that can be tagged.</span>
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">trait</span> <span class="ident">Taggable</span><span class="op"><</span><span class="ident">T</span>: <span class="ident">TagLike</span><span class="op">></span>: <span class="ident">Sized</span> {
|
||||
<span class="kw">fn</span> <span class="ident">tagged</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">tag</span>: <span class="ident">T</span>) <span class="op">-</span><span class="op">></span> <span class="ident">TaggedValue</span><span class="op"><</span><span class="kw-2">&</span><span class="self">Self</span>, <span class="ident">T</span><span class="op">></span> {
|
||||
@@ -822,7 +845,7 @@
|
||||
<span class="comment">// }</span>
|
||||
<span class="comment">// }</span>
|
||||
|
||||
<span class="kw">impl</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> <span class="ident">Encodable</span> <span class="kw">for</span> <span class="kw-2">&</span><span class="lifetime">'a</span> [<span class="ident">u8</span>] {
|
||||
<span class="kw">impl</span> <span class="ident">Encodable</span> <span class="kw">for</span> <span class="kw-2">&</span>[<span class="ident">u8</span>] {
|
||||
<span class="kw">fn</span> <span class="ident">encoded_length</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">Length</span><span class="op">></span> {
|
||||
<span class="self">self</span>.<span class="ident">len</span>().<span class="ident">try_into</span>()
|
||||
}
|
||||
@@ -833,6 +856,23 @@
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">Encodable</span> <span class="kw">for</span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="kw-2">&</span>[<span class="ident">u8</span>]<span class="op">></span> {
|
||||
<span class="kw">fn</span> <span class="ident">encoded_length</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">Length</span><span class="op">></span> {
|
||||
<span class="kw">match</span> <span class="self">self</span> {
|
||||
<span class="prelude-val">Some</span>(<span class="ident">slice</span>) <span class="op">=</span><span class="op">></span> <span class="ident">slice</span>.<span class="ident">encoded_length</span>(),
|
||||
<span class="prelude-val">None</span> <span class="op">=</span><span class="op">></span> <span class="prelude-val">Ok</span>(<span class="ident">Length</span>::<span class="ident">zero</span>()),
|
||||
}
|
||||
}
|
||||
|
||||
<span class="doccomment">/// Encode this value as BER-TLV using the provided [`Encoder`].</span>
|
||||
<span class="kw">fn</span> <span class="ident">encode</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">encoder</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">Encoder</span><span class="op"><</span><span class="lifetime">'_</span><span class="op">></span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span>()<span class="op">></span> {
|
||||
<span class="kw">match</span> <span class="self">self</span> {
|
||||
<span class="prelude-val">Some</span>(<span class="ident">slice</span>) <span class="op">=</span><span class="op">></span> <span class="ident">encoder</span>.<span class="ident">bytes</span>(<span class="ident">slice</span>),
|
||||
<span class="prelude-val">None</span> <span class="op">=</span><span class="op">></span> <span class="prelude-val">Ok</span>(())
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
<span class="macro">macro_rules</span><span class="macro">!</span> <span class="ident">impl_array</span> {
|
||||
($(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">N</span>:<span class="ident">literal</span>),<span class="kw-2">*</span>) <span class="op">=</span><span class="op">></span> {
|
||||
$(
|
||||
|
||||
@@ -150,6 +150,7 @@
|
||||
<span id="147">147</span>
|
||||
<span id="148">148</span>
|
||||
<span id="149">149</span>
|
||||
<span id="150">150</span>
|
||||
</pre><div class="example-wrap"><pre class="rust ">
|
||||
<span class="kw">use</span> <span class="ident">proc_macro2</span>::<span class="ident">TokenStream</span>;
|
||||
<span class="kw">use</span> <span class="ident">quote</span>::{<span class="ident">quote</span>, <span class="ident">ToTokens</span>};
|
||||
@@ -279,6 +280,7 @@
|
||||
<span class="ident">F</span>: <span class="ident">FnOnce</span>(<span class="kw-2">&</span>[<span class="kw-2">&</span><span class="kw">dyn</span> <span class="ident">flexiber</span>::<span class="ident">Encodable</span>]) <span class="op">-</span><span class="op">></span> <span class="ident">flexiber</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">T</span><span class="op">></span>,
|
||||
{
|
||||
<span class="kw">use</span> <span class="ident">core</span>::<span class="ident">convert</span>::<span class="ident">TryFrom</span>;
|
||||
<span class="kw">use</span> <span class="ident">flexiber</span>::<span class="ident">TagLike</span>;
|
||||
<span class="ident">field_encoder</span>(<span class="kw-2">&</span>[#<span class="ident">encode_fields</span>])
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user