| <!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="SHA-2 and the legacy SHA-1 digest algorithm."><meta name="keywords" content="rust, rustlang, rust-lang, digest"><title>ring::digest - 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" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../../ring/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../ring/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Module digest</a></h2><div class="sidebar-elems"><section><ul class="block"><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></section></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Module <a href="../index.html">ring</a>::<wbr><a class="mod" 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></h1><span class="out-of-band"><a class="srclink" href="../../src/ring/digest.rs.html#15-594">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><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></details><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Algorithm.html" title="ring::digest::Algorithm struct">Algorithm</a></div><div class="item-right docblock-short">A digest algorithm.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Context.html" title="ring::digest::Context struct">Context</a></div><div class="item-right docblock-short">A context for multi-step (Init-Update-Finish) digest calculations.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Digest.html" title="ring::digest::Digest struct">Digest</a></div><div class="item-right docblock-short">A calculated digest value.</div></div></div><h2 id="constants" class="small-section-header"><a href="#constants">Constants</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.MAX_BLOCK_LEN.html" title="ring::digest::MAX_BLOCK_LEN constant">MAX_BLOCK_LEN</a></div><div class="item-right docblock-short">The maximum block length (<code>Algorithm::block_len</code>) of all the algorithms in |
| this module.</div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.MAX_CHAINING_LEN.html" title="ring::digest::MAX_CHAINING_LEN constant">MAX_CHAINING_LEN</a></div><div class="item-right docblock-short">The maximum chaining length (<code>Algorithm::chaining_len</code>) of all the |
| algorithms in this module.</div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.MAX_OUTPUT_LEN.html" title="ring::digest::MAX_OUTPUT_LEN constant">MAX_OUTPUT_LEN</a></div><div class="item-right docblock-short">The maximum output length (<code>Algorithm::output_len</code>) of all the algorithms |
| in this module.</div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.SHA1_OUTPUT_LEN.html" title="ring::digest::SHA1_OUTPUT_LEN constant">SHA1_OUTPUT_LEN</a></div><div class="item-right docblock-short">The length of the output of SHA-1, in bytes.</div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.SHA256_OUTPUT_LEN.html" title="ring::digest::SHA256_OUTPUT_LEN constant">SHA256_OUTPUT_LEN</a></div><div class="item-right docblock-short">The length of the output of SHA-256, in bytes.</div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.SHA384_OUTPUT_LEN.html" title="ring::digest::SHA384_OUTPUT_LEN constant">SHA384_OUTPUT_LEN</a></div><div class="item-right docblock-short">The length of the output of SHA-384, in bytes.</div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.SHA512_256_OUTPUT_LEN.html" title="ring::digest::SHA512_256_OUTPUT_LEN constant">SHA512_256_OUTPUT_LEN</a></div><div class="item-right docblock-short">The length of the output of SHA-512/256, in bytes.</div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.SHA512_OUTPUT_LEN.html" title="ring::digest::SHA512_OUTPUT_LEN constant">SHA512_OUTPUT_LEN</a></div><div class="item-right docblock-short">The length of the output of SHA-512, in bytes.</div></div></div><h2 id="statics" class="small-section-header"><a href="#statics">Statics</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><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></div><div class="item-right docblock-short">SHA-1 as specified in <a href="http://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.180-4.pdf">FIPS 180-4</a>. Deprecated.</div></div><div class="item-row"><div class="item-left module-item"><a class="static" href="static.SHA256.html" title="ring::digest::SHA256 static">SHA256</a></div><div class="item-right docblock-short">SHA-256 as specified in <a href="http://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.180-4.pdf">FIPS 180-4</a>.</div></div><div class="item-row"><div class="item-left module-item"><a class="static" href="static.SHA384.html" title="ring::digest::SHA384 static">SHA384</a></div><div class="item-right docblock-short">SHA-384 as specified in <a href="http://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.180-4.pdf">FIPS 180-4</a>.</div></div><div class="item-row"><div class="item-left module-item"><a class="static" href="static.SHA512.html" title="ring::digest::SHA512 static">SHA512</a></div><div class="item-right docblock-short">SHA-512 as specified in <a href="http://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.180-4.pdf">FIPS 180-4</a>.</div></div><div class="item-row"><div class="item-left module-item"><a class="static" href="static.SHA512_256.html" title="ring::digest::SHA512_256 static">SHA512_256</a></div><div class="item-right docblock-short">SHA-512/256 as specified in <a href="http://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.180-4.pdf">FIPS 180-4</a>.</div></div></div><h2 id="functions" class="small-section-header"><a href="#functions">Functions</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.digest.html" title="ring::digest::digest fn">digest</a></div><div class="item-right docblock-short">Returns the digest of <code>data</code> using the given digest algorithm.</div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="ring" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
