30 lines
15 KiB
HTML
30 lines
15 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="Trait for returning digest result with the variable size"><meta name="keywords" content="rust, rustlang, rust-lang, VariableOutput"><title>VariableOutput in digest - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><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="../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../dark.css" disabled><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script src="../crates.js"></script><script defer src="../main.js"></script>
|
||
<noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.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="sidebar"><div class="sidebar-menu" role="button">☰</div><a class="sidebar-logo" href="../digest/index.html"><div class="logo-container"><img src="https://raw.githubusercontent.com/RustCrypto/meta/master/logo_small.png" alt="logo"></div>
|
||
</a><h2 class="location">Trait VariableOutput</h2><div class="sidebar-elems"><div class="block items"><h3 class="sidebar-title"><a href="#required-methods">Required Methods</a></h3><div class="sidebar-links"><a href="#tymethod.finalize_variable">finalize_variable</a><a href="#tymethod.finalize_variable_reset">finalize_variable_reset</a><a href="#tymethod.new">new</a><a href="#tymethod.output_size">output_size</a></div><h3 class="sidebar-title"><a href="#provided-methods">Provided Methods</a></h3><div class="sidebar-links"><a href="#method.finalize_boxed">finalize_boxed</a><a href="#method.finalize_boxed_reset">finalize_boxed_reset</a></div><h3 class="sidebar-title"><a href="#implementors">Implementors</a></h3></div><h2 class="location">Other items in<br><a href="index.html">digest</a></h2><div id="sidebar-vars" data-name="VariableOutput" data-ty="trait" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../digest/index.html"><img src="https://raw.githubusercontent.com/RustCrypto/meta/master/logo_small.png" alt="logo"></a><nav class="sub"><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="18" height="18" alt="Pick another theme!" src="../brush.svg"></button><div id="theme-choices" role="menu"></div></div><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" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../settings.html" title="settings"><img width="18" height="18" alt="Change settings" src="../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><h1 class="fqn"><span class="in-band">Trait <a href="index.html">digest</a>::<wbr><a class="trait" href="#">VariableOutput</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span><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/digest/variable.rs.html#9-57" title="goto source code">[src]</a></span></h1><div class="docblock item-decl"><pre class="rust trait"><code>pub trait VariableOutput: <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> {
|
||
fn <a href="#tymethod.new" class="fnname">new</a>(output_size: <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.usize.html">usize</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.59.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, <a class="struct" href="struct.InvalidOutputSize.html" title="struct digest::InvalidOutputSize">InvalidOutputSize</a>>;
|
||
<div class="item-spacer"></div> fn <a href="#tymethod.output_size" class="fnname">output_size</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.usize.html">usize</a>;
|
||
<div class="item-spacer"></div> fn <a href="#tymethod.finalize_variable" class="fnname">finalize_variable</a>(self, f: impl <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.slice.html">]</a>));
|
||
<div class="item-spacer"></div> fn <a href="#tymethod.finalize_variable_reset" class="fnname">finalize_variable_reset</a>(&mut self, f: impl <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.slice.html">]</a>));
|
||
|
||
fn <a href="#method.finalize_boxed" class="fnname">finalize_boxed</a>(self) -> <a class="struct" href="https://doc.rust-lang.org/1.59.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><<a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.slice.html">[</a><a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.slice.html">]</a>> { ... }
|
||
<div class="item-spacer"></div> fn <a href="#method.finalize_boxed_reset" class="fnname">finalize_boxed_reset</a>(&mut self) -> <a class="struct" href="https://doc.rust-lang.org/1.59.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><<a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.slice.html">[</a><a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.slice.html">]</a>> { ... }
|
||
}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Trait for returning digest result with the variable size</p>
|
||
</div></details><h2 id="required-methods" class="small-section-header">Required methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle" open><summary><div id="tymethod.new" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/digest/variable.rs.html#15" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#tymethod.new" class="fnname">new</a>(output_size: <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.usize.html">usize</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.59.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, <a class="struct" href="struct.InvalidOutputSize.html" title="struct digest::InvalidOutputSize">InvalidOutputSize</a>></h4></div></summary><div class="docblock"><p>Create new hasher instance with the given output size.</p>
|
||
<p>It will return <code>Err(InvalidOutputSize)</code> in case if hasher can not return
|
||
specified output size. It will always return an error if output size
|
||
equals to zero.</p>
|
||
</div></details><details class="rustdoc-toggle" open><summary><div id="tymethod.output_size" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/digest/variable.rs.html#18" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#tymethod.output_size" class="fnname">output_size</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.usize.html">usize</a></h4></div></summary><div class="docblock"><p>Get output size of the hasher instance provided to the <code>new</code> method</p>
|
||
</div></details><details class="rustdoc-toggle" open><summary><div id="tymethod.finalize_variable" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/digest/variable.rs.html#24" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#tymethod.finalize_variable" class="fnname">finalize_variable</a>(self, f: impl <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.slice.html">]</a>))</h4></div></summary><div class="docblock"><p>Retrieve result via closure and consume hasher.</p>
|
||
<p>Closure is guaranteed to be called, length of the buffer passed to it
|
||
will be equal to <code>output_size</code>.</p>
|
||
</div></details><details class="rustdoc-toggle" open><summary><div id="tymethod.finalize_variable_reset" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/digest/variable.rs.html#30" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#tymethod.finalize_variable_reset" class="fnname">finalize_variable_reset</a>(&mut self, f: impl <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.slice.html">]</a>))</h4></div></summary><div class="docblock"><p>Retrieve result via closure and reset the hasher state.</p>
|
||
<p>Closure is guaranteed to be called, length of the buffer passed to it
|
||
will be equal to <code>output_size</code>.</p>
|
||
</div></details></div><h2 id="provided-methods" class="small-section-header">Provided methods<a href="#provided-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle" open><summary><div id="method.finalize_boxed" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/digest/variable.rs.html#38-43" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#method.finalize_boxed" class="fnname">finalize_boxed</a>(self) -> <a class="struct" href="https://doc.rust-lang.org/1.59.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><<a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.slice.html">[</a><a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.slice.html">]</a>></h4></div></summary><div class="docblock"><p>Retrieve result into a boxed slice and consume hasher.</p>
|
||
<p><code>Box<[u8]></code> is used instead of <code>Vec<u8></code> to save stack space, since
|
||
they have size of 2 and 3 words respectively.</p>
|
||
</div></details><details class="rustdoc-toggle" open><summary><div id="method.finalize_boxed_reset" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/digest/variable.rs.html#51-56" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#method.finalize_boxed_reset" class="fnname">finalize_boxed_reset</a>(&mut self) -> <a class="struct" href="https://doc.rust-lang.org/1.59.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><<a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.slice.html">[</a><a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.slice.html">]</a>></h4></div></summary><div class="docblock"><p>Retrieve result into a boxed slice and reset hasher state.</p>
|
||
<p><code>Box<[u8]></code> is used instead of <code>Vec<u8></code> to save stack space, since
|
||
they have size of 2 and 3 words respectively.</p>
|
||
</div></details></div><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"><div id="impl-VariableOutput" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../src/digest/variable.rs.html#87-106" title="goto source code">[src]</a></div><a href="#impl-VariableOutput" class="anchor"></a><h3 class="code-header in-band">impl<D: <a class="trait" href="trait.VariableOutputDirty.html" title="trait digest::VariableOutputDirty">VariableOutputDirty</a> + <a class="trait" href="trait.Reset.html" title="trait digest::Reset">Reset</a>> <a class="trait" href="trait.VariableOutput.html" title="trait digest::VariableOutput">VariableOutput</a> for D</h3></div></div><script type="text/javascript" src="../implementors/digest/trait.VariableOutput.js" async></script></section><section id="search" class="content hidden"></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="digest" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.59.0 (9d1b2106e 2022-02-23)" ></div>
|
||
</body></html> |