33 lines
18 KiB
HTML
33 lines
18 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="The `Digest` trait specifies an interface common for digest functions."><meta name="keywords" content="rust, rustlang, rust-lang, Digest"><title>Digest in sha2 - 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="shortcut icon" href="https://raw.githubusercontent.com/RustCrypto/meta/master/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]--><nav class="sidebar"><div class="sidebar-menu" role="button">☰</div><a class="sidebar-logo" href="../sha2/index.html"><div class="logo-container"><img src="https://raw.githubusercontent.com/RustCrypto/meta/master/logo.svg" alt="logo"></div>
|
||
</a><h2 class="location">Trait Digest</h2><div class="sidebar-elems"><div class="block items"><h3 class="sidebar-title"><a href="#associated-types">Associated Types</a></h3><div class="sidebar-links"><a href="#associatedtype.OutputSize">OutputSize</a></div><h3 class="sidebar-title"><a href="#required-methods">Required Methods</a></h3><div class="sidebar-links"><a href="#tymethod.chain">chain</a><a href="#tymethod.digest">digest</a><a href="#tymethod.finalize">finalize</a><a href="#tymethod.finalize_reset">finalize_reset</a><a href="#tymethod.new">new</a><a href="#tymethod.output_size">output_size</a><a href="#tymethod.reset">reset</a><a href="#tymethod.update">update</a></div><h3 class="sidebar-title"><a href="#implementors">Implementors</a></h3></div><h2 class="location">Other items in<br><a href="index.html">sha2</a></h2><div id="sidebar-vars" data-name="Digest" 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="../sha2/index.html"><img src="https://raw.githubusercontent.com/RustCrypto/meta/master/logo.svg" 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">sha2</a>::<wbr><a class="trait" href="#">Digest</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/digest.rs.html#9-50" title="goto source code">[src]</a></span></h1><div class="docblock item-decl"><pre class="rust trait"><code>pub trait Digest {
|
||
type <a href="#associatedtype.OutputSize" class="associatedtype">OutputSize</a>: <a class="trait" href="../generic_array/trait.ArrayLength.html" title="trait generic_array::ArrayLength">ArrayLength</a><<a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.u8.html">u8</a>>;
|
||
fn <a href="#tymethod.new" class="fnname">new</a>() -> Self;
|
||
<div class="item-spacer"></div> fn <a href="#tymethod.update" class="fnname">update</a>(&mut self, data: impl <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</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.chain" class="fnname">chain</a>(self, data: impl <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</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>>) -> Self;
|
||
<div class="item-spacer"></div> fn <a href="#tymethod.finalize" class="fnname">finalize</a>(self) -> <a class="struct" href="../generic_array/struct.GenericArray.html" title="struct generic_array::GenericArray">GenericArray</a><<a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.u8.html">u8</a>, Self::<a class="associatedtype" href="trait.Digest.html#associatedtype.OutputSize" title="type sha2::Digest::OutputSize">OutputSize</a>>;
|
||
<div class="item-spacer"></div> fn <a href="#tymethod.finalize_reset" class="fnname">finalize_reset</a>(&mut self) -> <a class="struct" href="../generic_array/struct.GenericArray.html" title="struct generic_array::GenericArray">GenericArray</a><<a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.u8.html">u8</a>, Self::<a class="associatedtype" href="trait.Digest.html#associatedtype.OutputSize" title="type sha2::Digest::OutputSize">OutputSize</a>>;
|
||
<div class="item-spacer"></div> fn <a href="#tymethod.reset" class="fnname">reset</a>(&mut self);
|
||
<div class="item-spacer"></div> fn <a href="#tymethod.output_size" class="fnname">output_size</a>() -> <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.digest" class="fnname">digest</a>(data: <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>) -> <a class="struct" href="../generic_array/struct.GenericArray.html" title="struct generic_array::GenericArray">GenericArray</a><<a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.u8.html">u8</a>, Self::<a class="associatedtype" href="trait.Digest.html#associatedtype.OutputSize" title="type sha2::Digest::OutputSize">OutputSize</a>>;
|
||
}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>The <code>Digest</code> trait specifies an interface common for digest functions.</p>
|
||
<p>It’s a convenience wrapper around <a href="../digest/trait.Update.html" title="Update"><code>Update</code></a>, <a href="../digest/fixed/trait.FixedOutput.html" title="FixedOutput"><code>FixedOutput</code></a>, <a href="../digest/trait.Reset.html" title="Reset"><code>Reset</code></a>,
|
||
<a href="https://doc.rust-lang.org/1.59.0/core/clone/trait.Clone.html" title="Clone"><code>Clone</code></a>, and <a href="https://doc.rust-lang.org/1.59.0/core/default/trait.Default.html" title="Default"><code>Default</code></a> traits. It also provides additional convenience methods.</p>
|
||
</div></details><h2 id="associated-types" class="small-section-header">Associated Types<a href="#associated-types" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle" open><summary><div id="associatedtype.OutputSize" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/digest/digest.rs.html#11" title="goto source code">[src]</a></div><h4 class="code-header">type <a href="#associatedtype.OutputSize" class="associatedtype">OutputSize</a>: <a class="trait" href="../generic_array/trait.ArrayLength.html" title="trait generic_array::ArrayLength">ArrayLength</a><<a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.u8.html">u8</a>></h4></div></summary><div class="docblock"><p>Output size for <code>Digest</code></p>
|
||
</div></details></div><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/digest.rs.html#14" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#tymethod.new" class="fnname">new</a>() -> Self</h4></div></summary><div class="docblock"><p>Create new hasher instance</p>
|
||
</div></details><details class="rustdoc-toggle" open><summary><div id="tymethod.update" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/digest/digest.rs.html#19" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#tymethod.update" class="fnname">update</a>(&mut self, data: impl <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</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>Digest data, updating the internal state.</p>
|
||
<p>This method can be called repeatedly for use with streaming messages.</p>
|
||
</div></details><details class="rustdoc-toggle" open><summary><div id="tymethod.chain" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/digest/digest.rs.html#22-24" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#tymethod.chain" class="fnname">chain</a>(self, data: impl <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</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>>) -> Self</h4></div></summary><div class="docblock"><p>Digest input data in a chained manner.</p>
|
||
</div></details><details class="rustdoc-toggle" open><summary><div id="tymethod.finalize" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/digest/digest.rs.html#27" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#tymethod.finalize" class="fnname">finalize</a>(self) -> <a class="struct" href="../generic_array/struct.GenericArray.html" title="struct generic_array::GenericArray">GenericArray</a><<a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.u8.html">u8</a>, Self::<a class="associatedtype" href="trait.Digest.html#associatedtype.OutputSize" title="type sha2::Digest::OutputSize">OutputSize</a>></h4></div></summary><div class="docblock"><p>Retrieve result and consume hasher instance.</p>
|
||
</div></details><details class="rustdoc-toggle" open><summary><div id="tymethod.finalize_reset" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/digest/digest.rs.html#33" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#tymethod.finalize_reset" class="fnname">finalize_reset</a>(&mut self) -> <a class="struct" href="../generic_array/struct.GenericArray.html" title="struct generic_array::GenericArray">GenericArray</a><<a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.u8.html">u8</a>, Self::<a class="associatedtype" href="trait.Digest.html#associatedtype.OutputSize" title="type sha2::Digest::OutputSize">OutputSize</a>></h4></div></summary><div class="docblock"><p>Retrieve result and reset hasher instance.</p>
|
||
<p>This method sometimes can be more efficient compared to hasher
|
||
re-creation.</p>
|
||
</div></details><details class="rustdoc-toggle" open><summary><div id="tymethod.reset" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/digest/digest.rs.html#36" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#tymethod.reset" class="fnname">reset</a>(&mut self)</h4></div></summary><div class="docblock"><p>Reset hasher instance to its initial state.</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/digest.rs.html#39" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#tymethod.output_size" class="fnname">output_size</a>() -> <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</p>
|
||
</div></details><details class="rustdoc-toggle" open><summary><div id="tymethod.digest" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/digest/digest.rs.html#49" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#tymethod.digest" class="fnname">digest</a>(data: <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>) -> <a class="struct" href="../generic_array/struct.GenericArray.html" title="struct generic_array::GenericArray">GenericArray</a><<a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.u8.html">u8</a>, Self::<a class="associatedtype" href="trait.Digest.html#associatedtype.OutputSize" title="type sha2::Digest::OutputSize">OutputSize</a>></h4></div></summary><div class="docblock"><p>Convenience function to compute hash of the <code>data</code>. It will handle
|
||
hasher creation, data feeding and finalization.</p>
|
||
<p>Example:</p>
|
||
|
||
<div class='information'><div class='tooltip ignore'>ⓘ</div></div><div class="example-wrap"><pre class="rust rust-example-rendered ignore"><code><span class="macro">println!</span>(<span class="string">"{:x}"</span>, <span class="ident">sha2::Sha256::digest</span>(<span class="string">b"Hello world"</span>));</code></pre></div>
|
||
</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"><details class="rustdoc-toggle implementors-toggle"><summary><div id="impl-Digest" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../src/digest/digest.rs.html#52-93" title="goto source code">[src]</a></div><a href="#impl-Digest" class="anchor"></a><h3 class="code-header in-band">impl<D> <a class="trait" href="trait.Digest.html" title="trait sha2::Digest">Digest</a> for D <span class="where fmt-newline">where<br> D: <a class="trait" href="../digest/trait.Update.html" title="trait digest::Update">Update</a> + <a class="trait" href="../digest/fixed/trait.FixedOutput.html" title="trait digest::fixed::FixedOutput">FixedOutput</a> + <a class="trait" href="../digest/trait.Reset.html" title="trait digest::Reset">Reset</a> + <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> + <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/default/trait.Default.html" title="trait core::default::Default">Default</a>, </span></h3></div></summary><div class="impl-items"><div id="associatedtype.OutputSize-1" class="type trait-impl has-srclink"><a href="#associatedtype.OutputSize-1" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.OutputSize" class="associatedtype">OutputSize</a> = <D as <a class="trait" href="../digest/fixed/trait.FixedOutput.html" title="trait digest::fixed::FixedOutput">FixedOutput</a>>::<a class="associatedtype" href="../digest/fixed/trait.FixedOutput.html#associatedtype.OutputSize" title="type digest::fixed::FixedOutput::OutputSize">OutputSize</a></h4></div></div></details></div><script type="text/javascript" src="../implementors/digest/digest/trait.Digest.js" async></script></section><section id="search" class="content hidden"></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="sha2" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.59.0 (9d1b2106e 2022-02-23)" ></div>
|
||
</body></html> |