37 lines
15 KiB
HTML
37 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 hash functions with variable-size output."><title>VariableOutput 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="#">VariableOutput</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="#">Variable<wbr>Output</a></h2><h3><a href="#required-associated-consts">Required Associated Constants</a></h3><ul class="block"><li><a href="#associatedconstant.MAX_OUTPUT_SIZE" title="MAX_OUTPUT_SIZE">MAX_OUTPUT_SIZE</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.finalize_variable" title="finalize_variable">finalize_variable</a></li><li><a href="#tymethod.new" title="new">new</a></li><li><a href="#tymethod.output_size" title="output_size">output_size</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.digest_variable" title="digest_variable">digest_variable</a></li><li><a href="#method.finalize_boxed" title="finalize_boxed">finalize_boxed</a></li></ul><h3><a href="#dyn-compatibility">Dyn Compatibility</a></h3><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">Variable<wbr>Output</span> <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/lib.rs.html#203-251">Source</a> </span></div><pre class="rust item-decl"><code>pub trait VariableOutput: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="trait.Update.html" title="trait digest::Update">Update</a> {
|
|
const <a href="#associatedconstant.MAX_OUTPUT_SIZE" class="constant">MAX_OUTPUT_SIZE</a>: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.usize.html">usize</a>;
|
|
|
|
// Required methods
|
|
fn <a href="#tymethod.new" class="fn">new</a>(output_size: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.usize.html">usize</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/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>>;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.output_size" class="fn">output_size</a>(&self) -> <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.finalize_variable" class="fn">finalize_variable</a>(self, out: &mut [<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</a>]) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<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>>;
|
|
|
|
// Provided methods
|
|
fn <a href="#method.digest_variable" class="fn">digest_variable</a>(
|
|
input: impl <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><[<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</a>]>,
|
|
output: &mut [<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</a>],
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.unit.html">()</a>, <a class="struct" href="struct.InvalidOutputSize.html" title="struct digest::InvalidOutputSize">InvalidOutputSize</a>> { ... }
|
|
<span class="item-spacer"></span> fn <a href="#method.finalize_boxed" class="fn">finalize_boxed</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><[<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</a>]> { ... }
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Trait for hash functions with variable-size output.</p>
|
|
</div></details><h2 id="required-associated-consts" class="section-header">Required Associated Constants<a href="#required-associated-consts" class="anchor">§</a></h2><div class="methods"><details class="toggle" open><summary><section id="associatedconstant.MAX_OUTPUT_SIZE" class="method"><a class="src rightside" href="../src/digest/lib.rs.html#205">Source</a><h4 class="code-header">const <a href="#associatedconstant.MAX_OUTPUT_SIZE" class="constant">MAX_OUTPUT_SIZE</a>: <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>Maximum size of output hash.</p>
|
|
</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.new" class="method"><a class="src rightside" href="../src/digest/lib.rs.html#211">Source</a><h4 class="code-header">fn <a href="#tymethod.new" class="fn">new</a>(output_size: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.usize.html">usize</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/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></section></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
|
|
hash of the specified output size.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.output_size" class="method"><a class="src rightside" href="../src/digest/lib.rs.html#214">Source</a><h4 class="code-header">fn <a href="#tymethod.output_size" class="fn">output_size</a>(&self) -> <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 instance provided to the <code>new</code> method</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.finalize_variable" class="method"><a class="src rightside" href="../src/digest/lib.rs.html#220">Source</a><h4 class="code-header">fn <a href="#tymethod.finalize_variable" class="fn">finalize_variable</a>(self, out: &mut [<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</a>]) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<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>></h4></section></summary><div class="docblock"><p>Write result into the output buffer.</p>
|
|
<p>Returns <code>Err(InvalidOutputSize)</code> if <code>out</code> size is not equal to
|
|
<code>self.output_size()</code>.</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.digest_variable" class="method"><a class="src rightside" href="../src/digest/lib.rs.html#227-236">Source</a><h4 class="code-header">fn <a href="#method.digest_variable" class="fn">digest_variable</a>(
|
|
input: impl <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><[<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</a>]>,
|
|
output: &mut [<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</a>],
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.unit.html">()</a>, <a class="struct" href="struct.InvalidOutputSize.html" title="struct digest::InvalidOutputSize">InvalidOutputSize</a>></h4></section></summary><div class="docblock"><p>Compute hash of <code>data</code> and write it to <code>output</code>.</p>
|
|
<p>Length of the output hash is determined by <code>output</code>. If <code>output</code> is
|
|
bigger than <code>Self::MAX_OUTPUT_SIZE</code>, this method returns
|
|
<code>InvalidOutputSize</code>.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.finalize_boxed" class="method"><a class="src rightside" href="../src/digest/lib.rs.html#244-250">Source</a><h4 class="code-header">fn <a href="#method.finalize_boxed" class="fn">finalize_boxed</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><[<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>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></div><h2 id="dyn-compatibility" class="section-header">Dyn Compatibility<a href="#dyn-compatibility" class="anchor">§</a></h2><div class="dyn-compatibility-info"><p>This trait is <b>not</b> <a href="https://doc.rust-lang.org/1.93.1/reference/items/traits.html#dyn-compatibility">dyn compatible</a>.</p><p><i>In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.</i></p></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-VariableOutput-for-RtVariableCoreWrapper%3CT%3E" class="impl"><a class="src rightside" href="../src/digest/core_api/rt_variable.rs.html#96-120">Source</a><a href="#impl-VariableOutput-for-RtVariableCoreWrapper%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="trait.VariableOutput.html" title="trait digest::VariableOutput">VariableOutput</a> for <a class="struct" href="core_api/struct.RtVariableCoreWrapper.html" title="struct digest::core_api::RtVariableCoreWrapper">RtVariableCoreWrapper</a><T><div class="where">where
|
|
T: <a class="trait" href="core_api/trait.VariableOutputCore.html" title="trait digest::core_api::VariableOutputCore">VariableOutputCore</a> + <a class="trait" href="core_api/trait.UpdateCore.html" title="trait digest::core_api::UpdateCore">UpdateCore</a>,
|
|
T::<a class="associatedtype" href="core_api/trait.BlockSizeUser.html#associatedtype.BlockSize" title="type digest::core_api::BlockSizeUser::BlockSize">BlockSize</a>: <a class="trait" href="../typenum/type_operators/trait.IsLess.html" title="trait typenum::type_operators::IsLess">IsLess</a><<a class="type" href="consts/type.U256.html" title="type digest::consts::U256">U256</a>>,
|
|
<a class="type" href="../typenum/operator_aliases/type.Le.html" title="type typenum::operator_aliases::Le">Le</a><T::<a class="associatedtype" href="core_api/trait.BlockSizeUser.html#associatedtype.BlockSize" title="type digest::core_api::BlockSizeUser::BlockSize">BlockSize</a>, <a class="type" href="consts/type.U256.html" title="type digest::consts::U256">U256</a>>: <a class="trait" href="../typenum/marker_traits/trait.NonZero.html" title="trait typenum::marker_traits::NonZero">NonZero</a>,</div></h3></section></summary><div class="impl-items"><section id="associatedconstant.MAX_OUTPUT_SIZE-1" class="associatedconstant trait-impl"><a class="src rightside" href="../src/digest/core_api/rt_variable.rs.html#102">Source</a><a href="#associatedconstant.MAX_OUTPUT_SIZE-1" class="anchor">§</a><h4 class="code-header">const <a href="#associatedconstant.MAX_OUTPUT_SIZE" class="constant">MAX_OUTPUT_SIZE</a>: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.usize.html">usize</a> = <T::OutputSize>::USIZE</h4></section></div></details></div><script src="../trait.impl/digest/trait.VariableOutput.js" async></script></section></div></main></body></html> |