mirror of
https://gitlab.redox-os.org/CoffeeCode/redox-ssh.git
synced 2025-12-28 22:12:19 +01:00
173 lines
No EOL
12 KiB
HTML
173 lines
No EOL
12 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 `crypto`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, Digest">
|
||
|
||
<title>crypto::digest::Digest - Rust</title>
|
||
|
||
<link rel="stylesheet" type="text/css" href="../../normalize.css">
|
||
<link rel="stylesheet" type="text/css" href="../../rustdoc.css">
|
||
<link rel="stylesheet" type="text/css" href="../../main.css">
|
||
|
||
|
||
|
||
|
||
</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">
|
||
|
||
<p class='location'>Trait Digest</p><div class="block items"><ul><li><a href="#required-methods">Required Methods</a></li><li><a href="#provided-methods">Provided Methods</a></li><li><a href="#implementors">Implementors</a></li></ul></div><p class='location'><a href='../index.html'>crypto</a>::<wbr><a href='index.html'>digest</a></p><script>window.sidebarCurrent = {name: 'Digest', ty: 'trait', relpath: ''};</script><script defer src="sidebar-items.js"></script>
|
||
</nav>
|
||
|
||
<nav class="sub">
|
||
<form class="search-form js-only">
|
||
<div class="search-container">
|
||
<input class="search-input" name="search"
|
||
autocomplete="off"
|
||
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
|
||
type="search">
|
||
</div>
|
||
</form>
|
||
</nav>
|
||
|
||
<section id='main' class="content">
|
||
<h1 class='fqn'><span class='in-band'>Trait <a href='../index.html'>crypto</a>::<wbr><a href='index.html'>digest</a>::<wbr><a class="trait" href=''>Digest</a></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/crypto/digest.rs.html#17-81' title='goto source code'>[src]</a></span></h1>
|
||
<pre class='rust trait'>pub trait Digest {
|
||
fn <a href='#tymethod.input' class='fnname'>input</a>(&mut self, input: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>);
|
||
fn <a href='#tymethod.result' class='fnname'>result</a>(&mut self, out: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&mut [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>);
|
||
fn <a href='#tymethod.reset' class='fnname'>reset</a>(&mut self);
|
||
fn <a href='#tymethod.output_bits' class='fnname'>output_bits</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>;
|
||
fn <a href='#tymethod.block_size' class='fnname'>block_size</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>;
|
||
|
||
fn <a href='#method.output_bytes' class='fnname'>output_bytes</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a> { ... }
|
||
fn <a href='#method.input_str' class='fnname'>input_str</a>(&mut self, input: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) { ... }
|
||
fn <a href='#method.result_str' class='fnname'>result_str</a>(&mut self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/collections/string/struct.String.html" title="struct collections::string::String">String</a> { ... }
|
||
}</pre><div class='docblock'><p>The Digest trait specifies an interface common to digest functions, such as SHA-1 and the SHA-2
|
||
family of digest functions.</p>
|
||
</div>
|
||
<h2 id='required-methods'>Required Methods</h2>
|
||
<div class='methods'>
|
||
<h3 id='tymethod.input' class='method'><span id='input.v' class='invisible'><code>fn <a href='#tymethod.input' class='fnname'>input</a>(&mut self, input: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>)</code></span></h3><div class='docblock'><p>Provide message data.</p>
|
||
|
||
<h1 id='arguments' class='section-header'><a href='#arguments'>Arguments</a></h1>
|
||
<ul>
|
||
<li>input - A vector of message data</li>
|
||
</ul>
|
||
</div><h3 id='tymethod.result' class='method'><span id='result.v' class='invisible'><code>fn <a href='#tymethod.result' class='fnname'>result</a>(&mut self, out: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&mut [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>)</code></span></h3><div class='docblock'><p>Retrieve the digest result. This method may be called multiple times.</p>
|
||
|
||
<h1 id='arguments-1' class='section-header'><a href='#arguments-1'>Arguments</a></h1>
|
||
<ul>
|
||
<li>out - the vector to hold the result. Must be large enough to contain output_bits().</li>
|
||
</ul>
|
||
</div><h3 id='tymethod.reset' class='method'><span id='reset.v' class='invisible'><code>fn <a href='#tymethod.reset' class='fnname'>reset</a>(&mut self)</code></span></h3><div class='docblock'><p>Reset the digest. This method must be called after result() and before supplying more
|
||
data.</p>
|
||
</div><h3 id='tymethod.output_bits' class='method'><span id='output_bits.v' class='invisible'><code>fn <a href='#tymethod.output_bits' class='fnname'>output_bits</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></span></h3><div class='docblock'><p>Get the output size in bits.</p>
|
||
</div><h3 id='tymethod.block_size' class='method'><span id='block_size.v' class='invisible'><code>fn <a href='#tymethod.block_size' class='fnname'>block_size</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></span></h3><div class='docblock'><p>Get the block size in bytes.</p>
|
||
</div></div>
|
||
<h2 id='provided-methods'>Provided Methods</h2>
|
||
<div class='methods'>
|
||
<h3 id='method.output_bytes' class='method'><span id='output_bytes.v' class='invisible'><code>fn <a href='#method.output_bytes' class='fnname'>output_bytes</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></span></h3><div class='docblock'><p>Get the output size in bytes.</p>
|
||
</div><h3 id='method.input_str' class='method'><span id='input_str.v' class='invisible'><code>fn <a href='#method.input_str' class='fnname'>input_str</a>(&mut self, input: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>)</code></span></h3><div class='docblock'><p>Convenience function that feeds a string into a digest.</p>
|
||
|
||
<h1 id='arguments-2' class='section-header'><a href='#arguments-2'>Arguments</a></h1>
|
||
<ul>
|
||
<li><code>input</code> The string to feed into the digest</li>
|
||
</ul>
|
||
</div><h3 id='method.result_str' class='method'><span id='result_str.v' class='invisible'><code>fn <a href='#method.result_str' class='fnname'>result_str</a>(&mut self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/collections/string/struct.String.html" title="struct collections::string::String">String</a></code></span></h3><div class='docblock'><p>Convenience function that retrieves the result of a digest as a
|
||
String in hexadecimal format.</p>
|
||
</div></div>
|
||
<h2 id='implementors'>Implementors</h2>
|
||
<ul class='item-list' id='implementors-list'>
|
||
<li><code>impl Digest for <a class="struct" href="../../crypto/blake2b/struct.Blake2b.html" title="struct crypto::blake2b::Blake2b">Blake2b</a></code></li>
|
||
<li><code>impl Digest for <a class="struct" href="../../crypto/blake2s/struct.Blake2s.html" title="struct crypto::blake2s::Blake2s">Blake2s</a></code></li>
|
||
<li><code>impl Digest for <a class="struct" href="../../crypto/md5/struct.Md5.html" title="struct crypto::md5::Md5">Md5</a></code></li>
|
||
<li><code>impl Digest for <a class="struct" href="../../crypto/ripemd160/struct.Ripemd160.html" title="struct crypto::ripemd160::Ripemd160">Ripemd160</a></code></li>
|
||
<li><code>impl Digest for <a class="struct" href="../../crypto/sha1/struct.Sha1.html" title="struct crypto::sha1::Sha1">Sha1</a></code></li>
|
||
<li><code>impl Digest for <a class="struct" href="../../crypto/sha2/struct.Sha512.html" title="struct crypto::sha2::Sha512">Sha512</a></code></li>
|
||
<li><code>impl Digest for <a class="struct" href="../../crypto/sha2/struct.Sha384.html" title="struct crypto::sha2::Sha384">Sha384</a></code></li>
|
||
<li><code>impl Digest for <a class="struct" href="../../crypto/sha2/struct.Sha512Trunc256.html" title="struct crypto::sha2::Sha512Trunc256">Sha512Trunc256</a></code></li>
|
||
<li><code>impl Digest for <a class="struct" href="../../crypto/sha2/struct.Sha512Trunc224.html" title="struct crypto::sha2::Sha512Trunc224">Sha512Trunc224</a></code></li>
|
||
<li><code>impl Digest for <a class="struct" href="../../crypto/sha2/struct.Sha256.html" title="struct crypto::sha2::Sha256">Sha256</a></code></li>
|
||
<li><code>impl Digest for <a class="struct" href="../../crypto/sha2/struct.Sha224.html" title="struct crypto::sha2::Sha224">Sha224</a></code></li>
|
||
<li><code>impl Digest for <a class="struct" href="../../crypto/sha3/struct.Sha3.html" title="struct crypto::sha3::Sha3">Sha3</a></code></li>
|
||
<li><code>impl Digest for <a class="struct" href="../../crypto/whirlpool/struct.Whirlpool.html" title="struct crypto::whirlpool::Whirlpool">Whirlpool</a></code></li>
|
||
</ul><script type="text/javascript" async
|
||
src="../../implementors/crypto/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>?</dt>
|
||
<dd>Show this help dialog</dd>
|
||
<dt>S</dt>
|
||
<dd>Focus the search field</dd>
|
||
<dt>⇤</dt>
|
||
<dd>Move up in search results</dd>
|
||
<dt>⇥</dt>
|
||
<dd>Move down in search results</dd>
|
||
<dt>⏎</dt>
|
||
<dd>Go to active search result</dd>
|
||
<dt>+</dt>
|
||
<dd>Collapse/expand 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>
|
||
</div>
|
||
</div>
|
||
</aside>
|
||
|
||
|
||
|
||
<script>
|
||
window.rootPath = "../../";
|
||
window.currentCrate = "crypto";
|
||
</script>
|
||
<script src="../../main.js"></script>
|
||
<script defer src="../../search-index.js"></script>
|
||
</body>
|
||
</html> |