Files
GopherGate/target/doc/digest/trait.DynDigest.html
2026-02-26 12:00:21 -05:00

31 lines
16 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="Modification of the `Digest` trait suitable for trait objects."><title>DynDigest in digest - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="digest" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../static.files/storage-e2aeef58.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-263c88ec.css"></noscript><link rel="icon" href="https://raw.githubusercontent.com/RustCrypto/media/6ee8e381/logo.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]--><rustdoc-topbar><h2><a href="#">DynDigest</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../digest/index.html"><img src="https://raw.githubusercontent.com/RustCrypto/media/6ee8e381/logo.svg" alt="logo"></a><h2><a href="../digest/index.html">digest</a><span class="version">0.10.7</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">DynDigest</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.box_clone" title="box_clone">box_clone</a></li><li><a href="#tymethod.finalize_into" title="finalize_into">finalize_into</a></li><li><a href="#tymethod.finalize_into_reset" title="finalize_into_reset">finalize_into_reset</a></li><li><a href="#tymethod.output_size" title="output_size">output_size</a></li><li><a href="#tymethod.reset" title="reset">reset</a></li><li><a href="#tymethod.update" title="update">update</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.finalize" title="finalize">finalize</a></li><li><a href="#method.finalize_reset" title="finalize_reset">finalize_reset</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-Clone-for-Box%3Cdyn+DynDigest%3E" title="Clone">Clone</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate digest</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="index.html">digest</a></div><h1>Trait <span class="trait">DynDigest</span>&nbsp;<button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/digest/digest.rs.html#132-177">Source</a> </span></div><pre class="rust item-decl"><code>pub trait DynDigest {
// Required methods
fn <a href="#tymethod.update" class="fn">update</a>(&amp;mut self, data: &amp;[<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</a>]);
<span class="item-spacer"></span> fn <a href="#tymethod.finalize_into" class="fn">finalize_into</a>(self, buf: &amp;mut [<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</a>]) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.unit.html">()</a>, <a class="struct" href="struct.InvalidBufferSize.html" title="struct digest::InvalidBufferSize">InvalidBufferSize</a>&gt;;
<span class="item-spacer"></span> fn <a href="#tymethod.finalize_into_reset" class="fn">finalize_into_reset</a>(
&amp;mut self,
out: &amp;mut [<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</a>],
) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.unit.html">()</a>, <a class="struct" href="struct.InvalidBufferSize.html" title="struct digest::InvalidBufferSize">InvalidBufferSize</a>&gt;;
<span class="item-spacer"></span> fn <a href="#tymethod.reset" class="fn">reset</a>(&amp;mut self);
<span class="item-spacer"></span> fn <a href="#tymethod.output_size" class="fn">output_size</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.usize.html">usize</a>;
<span class="item-spacer"></span> fn <a href="#tymethod.box_clone" class="fn">box_clone</a>(&amp;self) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.93.1/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;dyn <a class="trait" href="trait.DynDigest.html" title="trait digest::DynDigest">DynDigest</a>&gt;;
// Provided methods
fn <a href="#method.finalize_reset" class="fn">finalize_reset</a>(&amp;mut self) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.93.1/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;[<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</a>]&gt; { ... }
<span class="item-spacer"></span> fn <a href="#method.finalize" class="fn">finalize</a>(self: <a class="struct" href="https://doc.rust-lang.org/1.93.1/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;Self&gt;) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.93.1/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;[<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</a>]&gt; { ... }
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Modification of the <a href="trait.Digest.html" title="trait digest::Digest"><code>Digest</code></a> trait suitable for trait objects.</p>
</div></details><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.update" class="method"><a class="src rightside" href="../src/digest/digest.rs.html#136">Source</a><h4 class="code-header">fn <a href="#tymethod.update" class="fn">update</a>(&amp;mut self, data: &amp;[<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</a>])</h4></section></summary><div class="docblock"><p>Digest input data.</p>
<p>This method can be called repeatedly for use with streaming messages.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.finalize_into" class="method"><a class="src rightside" href="../src/digest/digest.rs.html#160">Source</a><h4 class="code-header">fn <a href="#tymethod.finalize_into" class="fn">finalize_into</a>(self, buf: &amp;mut [<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</a>]) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.unit.html">()</a>, <a class="struct" href="struct.InvalidBufferSize.html" title="struct digest::InvalidBufferSize">InvalidBufferSize</a>&gt;</h4></section></summary><div class="docblock"><p>Write result into provided array and consume the hasher instance.</p>
<p>Returns error if buffer length is not equal to <code>output_size</code>.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.finalize_into_reset" class="method"><a class="src rightside" href="../src/digest/digest.rs.html#165">Source</a><h4 class="code-header">fn <a href="#tymethod.finalize_into_reset" class="fn">finalize_into_reset</a>(
&amp;mut self,
out: &amp;mut [<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</a>],
) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.unit.html">()</a>, <a class="struct" href="struct.InvalidBufferSize.html" title="struct digest::InvalidBufferSize">InvalidBufferSize</a>&gt;</h4></section></summary><div class="docblock"><p>Write result into provided array and reset the hasher instance.</p>
<p>Returns error if buffer length is not equal to <code>output_size</code>.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.reset" class="method"><a class="src rightside" href="../src/digest/digest.rs.html#168">Source</a><h4 class="code-header">fn <a href="#tymethod.reset" class="fn">reset</a>(&amp;mut self)</h4></section></summary><div class="docblock"><p>Reset hasher instance to its initial state.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.output_size" class="method"><a class="src rightside" href="../src/digest/digest.rs.html#171">Source</a><h4 class="code-header">fn <a href="#tymethod.output_size" class="fn">output_size</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>Get output size of the hasher</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.box_clone" class="method"><a class="src rightside" href="../src/digest/digest.rs.html#176">Source</a><h4 class="code-header">fn <a href="#tymethod.box_clone" class="fn">box_clone</a>(&amp;self) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.93.1/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;dyn <a class="trait" href="trait.DynDigest.html" title="trait digest::DynDigest">DynDigest</a>&gt;</h4></section></summary><div class="docblock"><p>Clone hasher state into a boxed trait object</p>
</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.finalize_reset" class="method"><a class="src rightside" href="../src/digest/digest.rs.html#141-145">Source</a><h4 class="code-header">fn <a href="#method.finalize_reset" class="fn">finalize_reset</a>(&amp;mut self) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.93.1/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;[<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</a>]&gt;</h4></section></summary><div class="docblock"><p>Retrieve result and reset hasher instance</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.finalize" class="method"><a class="src rightside" href="../src/digest/digest.rs.html#151-155">Source</a><h4 class="code-header">fn <a href="#method.finalize" class="fn">finalize</a>(self: <a class="struct" href="https://doc.rust-lang.org/1.93.1/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;Self&gt;) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.93.1/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;[<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</a>]&gt;</h4></section></summary><div class="docblock"><p>Retrieve result and consume boxed hasher instance</p>
</div></details></div><h2 id="trait-implementations" class="section-header">Trait Implementations<a href="#trait-implementations" class="anchor">§</a></h2><div id="trait-implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Clone-for-Box%3Cdyn+DynDigest%3E" class="impl"><a class="src rightside" href="../src/digest/digest.rs.html#232-236">Source</a><a href="#impl-Clone-for-Box%3Cdyn+DynDigest%3E" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="https://doc.rust-lang.org/1.93.1/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;dyn <a class="trait" href="trait.DynDigest.html" title="trait digest::DynDigest">DynDigest</a>&gt;</h3><span class="item-info"><div class="stab portability">Available on <strong>crate feature <code>alloc</code></strong> only.</div></span></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.clone" class="method trait-impl"><a class="src rightside" href="../src/digest/digest.rs.html#233-235">Source</a><a href="#method.clone" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/clone/trait.Clone.html#tymethod.clone" class="fn">clone</a>(&amp;self) -&gt; Self</h4></section></summary><div class='docblock'>Returns a duplicate of the value. <a href="https://doc.rust-lang.org/1.93.1/core/clone/trait.Clone.html#tymethod.clone">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.clone_from" class="method trait-impl"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.93.1/src/core/clone.rs.html#245-247">Source</a></span><a href="#method.clone_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/clone/trait.Clone.html#method.clone_from" class="fn">clone_from</a>(&amp;mut self, source: &amp;Self)</h4></section></summary><div class='docblock'>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/1.93.1/core/clone/trait.Clone.html#method.clone_from">Read more</a></div></details></div></details></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-DynDigest-for-D" class="impl"><a class="src rightside" href="../src/digest/digest.rs.html#179-228">Source</a><a href="#impl-DynDigest-for-D" class="anchor">§</a><h3 class="code-header">impl&lt;D: <a class="trait" href="trait.Update.html" title="trait digest::Update">Update</a> + <a class="trait" href="trait.FixedOutputReset.html" title="trait digest::FixedOutputReset">FixedOutputReset</a> + <a class="trait" href="trait.Reset.html" title="trait digest::Reset">Reset</a> + <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> + 'static&gt; <a class="trait" href="trait.DynDigest.html" title="trait digest::DynDigest">DynDigest</a> for D</h3></section></div><script src="../trait.impl/digest/digest/trait.DynDigest.js" async></script></section></div></main></body></html>