mirror of
https://github.com/fluencelabs/wasmer
synced 2025-04-25 10:22:19 +00:00
35 lines
17 KiB
HTML
35 lines
17 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="API documentation for the Rust `Digest` trait in crate `digest`."><meta name="keywords" content="rust, rustlang, rust-lang, Digest"><title>digest::Digest - 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="../dark.css"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><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='../digest/index.html'><div class='logo-container'><img src='https://raw.githubusercontent.com/RustCrypto/meta/master/logo_small.png' alt='logo'></div></a><p class='location'>Trait Digest</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#associated-types">Associated Types</a><div class="sidebar-links"><a href="#associatedtype.OutputSize">OutputSize</a></div><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.chain">chain</a><a href="#tymethod.digest">digest</a><a href="#tymethod.input">input</a><a href="#tymethod.new">new</a><a href="#tymethod.output_size">output_size</a><a href="#tymethod.reset">reset</a><a href="#tymethod.result">result</a><a href="#tymethod.result_reset">result_reset</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='index.html'>digest</a></p><script>window.sidebarCurrent = {name: 'Digest', 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!"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form js-only"><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><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/digest/digest.rs.html#9-46' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='index.html'>digest</a>::<wbr><a class="trait" href=''>Digest</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub trait Digest {
|
||
type <a href='#associatedtype.OutputSize' class="type">OutputSize</a>: <a class="trait" href="../generic_array/trait.ArrayLength.html" title="trait generic_array::ArrayLength">ArrayLength</a><u8>;
|
||
fn <a href='#tymethod.new' class='fnname'>new</a>() -> Self;
|
||
<div class='item-spacer'></div> fn <a href='#tymethod.input' class='fnname'>input</a><B: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><[u8]>>(&mut self, data: B);
|
||
<div class='item-spacer'></div> fn <a href='#tymethod.chain' class='fnname'>chain</a><B: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><[u8]>>(self, data: B) -> Self<br> <span class="where">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a></span>;
|
||
<div class='item-spacer'></div> fn <a href='#tymethod.result' class='fnname'>result</a>(self) -> <a class="struct" href="../generic_array/struct.GenericArray.html" title="struct generic_array::GenericArray">GenericArray</a><u8, Self::<a class="type" href="../digest/trait.Digest.html#associatedtype.OutputSize" title="type digest::Digest::OutputSize">OutputSize</a>>;
|
||
<div class='item-spacer'></div> fn <a href='#tymethod.result_reset' class='fnname'>result_reset</a>(&mut self) -> <a class="struct" href="../generic_array/struct.GenericArray.html" title="struct generic_array::GenericArray">GenericArray</a><u8, Self::<a class="type" href="../digest/trait.Digest.html#associatedtype.OutputSize" title="type digest::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>() -> usize;
|
||
<div class='item-spacer'></div> fn <a href='#tymethod.digest' class='fnname'>digest</a>(data: &[u8]) -> <a class="struct" href="../generic_array/struct.GenericArray.html" title="struct generic_array::GenericArray">GenericArray</a><u8, Self::<a class="type" href="../digest/trait.Digest.html#associatedtype.OutputSize" title="type digest::Digest::OutputSize">OutputSize</a>>;
|
||
}</pre></div><div class='docblock'><p>The <code>Digest</code> trait specifies an interface common for digest functions.</p>
|
||
<p>It's a convenience wrapper around <code>Input</code>, <code>FixedOutput</code>, <code>Reset</code>, <code>Clone</code>,
|
||
and <code>Default</code> traits. It also provides additional convenience methods.</p>
|
||
</div>
|
||
<h2 id='associated-types' class='small-section-header'>Associated Types<a href='#associated-types' class='anchor'></a></h2><div class='methods'><h3 id='associatedtype.OutputSize' class='method'><code id='OutputSize.t'>type <a href='#associatedtype.OutputSize' class="type">OutputSize</a>: <a class="trait" href="../generic_array/trait.ArrayLength.html" title="trait generic_array::ArrayLength">ArrayLength</a><u8></code></h3></div><span class='loading-content'>Loading content...</span>
|
||
<h2 id='required-methods' class='small-section-header'>Required methods<a href='#required-methods' class='anchor'></a></h2><div class='methods'><h3 id='tymethod.new' class='method'><code id='new.v'>fn <a href='#tymethod.new' class='fnname'>new</a>() -> Self</code></h3><div class='docblock'><p>Create new hasher instance</p>
|
||
</div><h3 id='tymethod.input' class='method'><code id='input.v'>fn <a href='#tymethod.input' class='fnname'>input</a><B: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><[u8]>>(&mut self, data: B)</code></h3><div class='docblock'><p>Digest input data.</p>
|
||
<p>This method can be called repeatedly for use with streaming messages.</p>
|
||
</div><h3 id='tymethod.chain' class='method'><code id='chain.v'>fn <a href='#tymethod.chain' class='fnname'>chain</a><B: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><[u8]>>(self, data: B) -> Self <span class="where fmt-newline">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code></h3><div class='docblock'><p>Digest input data in a chained manner.</p>
|
||
</div><h3 id='tymethod.result' class='method'><code id='result.v'>fn <a href='#tymethod.result' class='fnname'>result</a>(self) -> <a class="struct" href="../generic_array/struct.GenericArray.html" title="struct generic_array::GenericArray">GenericArray</a><u8, Self::<a class="type" href="../digest/trait.Digest.html#associatedtype.OutputSize" title="type digest::Digest::OutputSize">OutputSize</a>></code></h3><div class='docblock'><p>Retrieve result and consume hasher instance.</p>
|
||
</div><h3 id='tymethod.result_reset' class='method'><code id='result_reset.v'>fn <a href='#tymethod.result_reset' class='fnname'>result_reset</a>(&mut self) -> <a class="struct" href="../generic_array/struct.GenericArray.html" title="struct generic_array::GenericArray">GenericArray</a><u8, Self::<a class="type" href="../digest/trait.Digest.html#associatedtype.OutputSize" title="type digest::Digest::OutputSize">OutputSize</a>></code></h3><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><h3 id='tymethod.reset' class='method'><code id='reset.v'>fn <a href='#tymethod.reset' class='fnname'>reset</a>(&mut self)</code></h3><div class='docblock'><p>Reset hasher instance to its initial state.</p>
|
||
</div><h3 id='tymethod.output_size' class='method'><code id='output_size.v'>fn <a href='#tymethod.output_size' class='fnname'>output_size</a>() -> usize</code></h3><div class='docblock'><p>Get output size of the hasher</p>
|
||
</div><h3 id='tymethod.digest' class='method'><code id='digest.v'>fn <a href='#tymethod.digest' class='fnname'>digest</a>(data: &[u8]) -> <a class="struct" href="../generic_array/struct.GenericArray.html" title="struct generic_array::GenericArray">GenericArray</a><u8, Self::<a class="type" href="../digest/trait.Digest.html#associatedtype.OutputSize" title="type digest::Digest::OutputSize">OutputSize</a>></code></h3><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'>ⓘ<span class='tooltiptext'>This example is not tested</span></div></div><div class="example-wrap"><pre class="rust rust-example-rendered ignore">
|
||
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"{:x}"</span>, <span class="ident">sha2</span>::<span class="ident">Sha256</span>::<span class="ident">digest</span>(<span class="string">b"Hello world"</span>));</pre></div>
|
||
</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'><h3 id='impl-Digest' class='impl'><code class='in-band'>impl<D: <a class="trait" href="../digest/trait.Input.html" title="trait digest::Input">Input</a> + <a class="trait" href="../digest/trait.FixedOutput.html" title="trait digest::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/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html" title="trait core::default::Default">Default</a>> Digest for D</code><a href='#impl-Digest' class='anchor'></a><a class='srclink' href='../src/digest/digest.rs.html#48-86' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.OutputSize-1' class="type"><code id='OutputSize.t-1'>type <a href='#associatedtype.OutputSize-1' class="type">OutputSize</a> = Self::<a class="type" href="../digest/trait.FixedOutput.html#associatedtype.OutputSize" title="type digest::FixedOutput::OutputSize">OutputSize</a></code></h4><h4 id='method.new' class="method hidden"><code id='new.v-1'>fn <a href='#method.new' class='fnname'>new</a>() -> Self</code><a class='srclink' href='../src/digest/digest.rs.html#51-53' title='goto source code'>[src]</a></h4><h4 id='method.input' class="method hidden"><code id='input.v-1'>fn <a href='#method.input' class='fnname'>input</a><B: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><[u8]>>(&mut self, data: B)</code><a class='srclink' href='../src/digest/digest.rs.html#55-57' title='goto source code'>[src]</a></h4><h4 id='method.chain' class="method hidden"><code id='chain.v-1'>fn <a href='#method.chain' class='fnname'>chain</a><B: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><[u8]>>(self, data: B) -> Self <span class="where fmt-newline">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a class='srclink' href='../src/digest/digest.rs.html#59-61' title='goto source code'>[src]</a></h4><h4 id='method.result' class="method hidden"><code id='result.v-1'>fn <a href='#method.result' class='fnname'>result</a>(self) -> <a class="struct" href="../generic_array/struct.GenericArray.html" title="struct generic_array::GenericArray">GenericArray</a><u8, Self::<a class="type" href="../digest/trait.Digest.html#associatedtype.OutputSize" title="type digest::Digest::OutputSize">OutputSize</a>></code><a class='srclink' href='../src/digest/digest.rs.html#63-65' title='goto source code'>[src]</a></h4><h4 id='method.result_reset' class="method hidden"><code id='result_reset.v-1'>fn <a href='#method.result_reset' class='fnname'>result_reset</a>(&mut self) -> <a class="struct" href="../generic_array/struct.GenericArray.html" title="struct generic_array::GenericArray">GenericArray</a><u8, Self::<a class="type" href="../digest/trait.Digest.html#associatedtype.OutputSize" title="type digest::Digest::OutputSize">OutputSize</a>></code><a class='srclink' href='../src/digest/digest.rs.html#67-71' title='goto source code'>[src]</a></h4><h4 id='method.reset' class="method hidden"><code id='reset.v-1'>fn <a href='#method.reset' class='fnname'>reset</a>(&mut self)</code><a class='srclink' href='../src/digest/digest.rs.html#73-75' title='goto source code'>[src]</a></h4><h4 id='method.output_size' class="method hidden"><code id='output_size.v-1'>fn <a href='#method.output_size' class='fnname'>output_size</a>() -> usize</code><a class='srclink' href='../src/digest/digest.rs.html#77-79' title='goto source code'>[src]</a></h4><h4 id='method.digest' class="method hidden"><code id='digest.v-1'>fn <a href='#method.digest' class='fnname'>digest</a>(data: &[u8]) -> <a class="struct" href="../generic_array/struct.GenericArray.html" title="struct generic_array::GenericArray">GenericArray</a><u8, Self::<a class="type" href="../digest/trait.Digest.html#associatedtype.OutputSize" title="type digest::Digest::OutputSize">OutputSize</a>></code><a class='srclink' href='../src/digest/digest.rs.html#81-85' title='goto source code'>[src]</a></h4></div></div><span class='loading-content'>Loading content...</span><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
|
||
src="../implementors/digest/trait.Digest.js">
|
||
</script></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g., <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g., <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../";window.currentCrate = "digest";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |