Files
google-apis-rs/ring/digest/index.html
2021-04-02 00:20:57 +08:00

33 lines
8.5 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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` mod in crate `ring`."><meta name="keywords" content="rust, rustlang, rust-lang, digest"><title>ring::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="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[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">&#9776;</div><a href='../../ring/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><p class="location">Module digest</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#constants">Constants</a></li><li><a href="#statics">Statics</a></li><li><a href="#functions">Functions</a></li></ul></div><p class="location"><a href="../index.html">ring</a></p><div id="sidebar-vars" data-name="digest" data-ty="mod" data-relpath="../"></div><script defer src="../sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../theme.js"></script><nav class="sub"><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" disabled autocomplete="off" spellcheck="false" placeholder="Click or press S to search, ? for more options…" type="search"></div><button type="button" class="help-button">?</button>
<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="in-band">Module <a href="../index.html">ring</a>::<wbr><a class="mod" 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">&#x2212;</span>]</a></span><a class="srclink" href="../../src/ring/digest.rs.html#15-594" title="goto source code">[src]</a></span></h1><div class="docblock"><p>SHA-2 and the legacy SHA-1 digest algorithm.</p>
<p>If all the data is available in a single contiguous slice then the <code>digest</code>
function should be used. Otherwise, the digest can be calculated in
multiple steps using <code>Context</code>.</p>
</div><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2>
<table><tr class="module-item"><td><a class="struct" href="struct.Algorithm.html" title="ring::digest::Algorithm struct">Algorithm</a></td><td class="docblock-short"><p>A digest algorithm.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Context.html" title="ring::digest::Context struct">Context</a></td><td class="docblock-short"><p>A context for multi-step (Init-Update-Finish) digest calculations.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Digest.html" title="ring::digest::Digest struct">Digest</a></td><td class="docblock-short"><p>A calculated digest value.</p>
</td></tr></table><h2 id="constants" class="section-header"><a href="#constants">Constants</a></h2>
<table><tr class="module-item"><td><a class="constant" href="constant.MAX_BLOCK_LEN.html" title="ring::digest::MAX_BLOCK_LEN constant">MAX_BLOCK_LEN</a></td><td class="docblock-short"><p>The maximum block length (<code>Algorithm::block_len</code>) of all the algorithms in
this module.</p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.MAX_CHAINING_LEN.html" title="ring::digest::MAX_CHAINING_LEN constant">MAX_CHAINING_LEN</a></td><td class="docblock-short"><p>The maximum chaining length (<code>Algorithm::chaining_len</code>) of all the
algorithms in this module.</p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.MAX_OUTPUT_LEN.html" title="ring::digest::MAX_OUTPUT_LEN constant">MAX_OUTPUT_LEN</a></td><td class="docblock-short"><p>The maximum output length (<code>Algorithm::output_len</code>) of all the algorithms
in this module.</p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.SHA1_OUTPUT_LEN.html" title="ring::digest::SHA1_OUTPUT_LEN constant">SHA1_OUTPUT_LEN</a></td><td class="docblock-short"><p>The length of the output of SHA-1, in bytes.</p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.SHA256_OUTPUT_LEN.html" title="ring::digest::SHA256_OUTPUT_LEN constant">SHA256_OUTPUT_LEN</a></td><td class="docblock-short"><p>The length of the output of SHA-256, in bytes.</p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.SHA384_OUTPUT_LEN.html" title="ring::digest::SHA384_OUTPUT_LEN constant">SHA384_OUTPUT_LEN</a></td><td class="docblock-short"><p>The length of the output of SHA-384, in bytes.</p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.SHA512_256_OUTPUT_LEN.html" title="ring::digest::SHA512_256_OUTPUT_LEN constant">SHA512_256_OUTPUT_LEN</a></td><td class="docblock-short"><p>The length of the output of SHA-512/256, in bytes.</p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.SHA512_OUTPUT_LEN.html" title="ring::digest::SHA512_OUTPUT_LEN constant">SHA512_OUTPUT_LEN</a></td><td class="docblock-short"><p>The length of the output of SHA-512, in bytes.</p>
</td></tr></table><h2 id="statics" class="section-header"><a href="#statics">Statics</a></h2>
<table><tr class="module-item"><td><a class="static" href="static.SHA1_FOR_LEGACY_USE_ONLY.html" title="ring::digest::SHA1_FOR_LEGACY_USE_ONLY static">SHA1_FOR_LEGACY_USE_ONLY</a></td><td class="docblock-short"><p>SHA-1 as specified in <a href="http://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.180-4.pdf">FIPS 180-4</a>. Deprecated.</p>
</td></tr><tr class="module-item"><td><a class="static" href="static.SHA256.html" title="ring::digest::SHA256 static">SHA256</a></td><td class="docblock-short"><p>SHA-256 as specified in <a href="http://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.180-4.pdf">FIPS 180-4</a>.</p>
</td></tr><tr class="module-item"><td><a class="static" href="static.SHA384.html" title="ring::digest::SHA384 static">SHA384</a></td><td class="docblock-short"><p>SHA-384 as specified in <a href="http://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.180-4.pdf">FIPS 180-4</a>.</p>
</td></tr><tr class="module-item"><td><a class="static" href="static.SHA512.html" title="ring::digest::SHA512 static">SHA512</a></td><td class="docblock-short"><p>SHA-512 as specified in <a href="http://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.180-4.pdf">FIPS 180-4</a>.</p>
</td></tr><tr class="module-item"><td><a class="static" href="static.SHA512_256.html" title="ring::digest::SHA512_256 static">SHA512_256</a></td><td class="docblock-short"><p>SHA-512/256 as specified in <a href="http://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.180-4.pdf">FIPS 180-4</a>.</p>
</td></tr></table><h2 id="functions" class="section-header"><a href="#functions">Functions</a></h2>
<table><tr class="module-item"><td><a class="fn" href="fn.digest.html" title="ring::digest::digest fn">digest</a></td><td class="docblock-short"><p>Returns the digest of <code>data</code> using the given digest algorithm.</p>
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="ring"></div>
<script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>