Files
GopherGate/target/doc/ring/digest/index.html
2026-02-26 12:00:21 -05:00

8 lines
7.8 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="SHA-2 and the legacy SHA-1 digest algorithm."><title>ring::digest - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="ring" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.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]--><rustdoc-topbar><h2><a href="#">Module digest</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../ring/index.html">ring</a><span class="version">0.17.14</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module digest</a></h2><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#constants" title="Constants">Constants</a></li><li><a href="#statics" title="Statics">Statics</a></li><li><a href="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate ring</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">ring</a></div><h1>Module <span>digest</span>&nbsp;<button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/ring/digest.rs.html#15-680">Source</a> </span></div><details class="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="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.Algorithm.html" title="struct ring::digest::Algorithm">Algorithm</a></dt><dd>A digest algorithm.</dd><dt><a class="struct" href="struct.Context.html" title="struct ring::digest::Context">Context</a></dt><dd>A context for multi-step (Init-Update-Finish) digest calculations.</dd><dt><a class="struct" href="struct.Digest.html" title="struct ring::digest::Digest">Digest</a></dt><dd>A calculated digest value.</dd></dl><h2 id="constants" class="section-header">Constants<a href="#constants" class="anchor">§</a></h2><dl class="item-table"><dt><a class="constant" href="constant.MAX_BLOCK_LEN.html" title="constant ring::digest::MAX_BLOCK_LEN">MAX_<wbr>BLOCK_<wbr>LEN</a></dt><dd>The maximum block length (<a href="struct.Algorithm.html#method.block_len" title="method ring::digest::Algorithm::block_len"><code>Algorithm::block_len()</code></a>) of all the algorithms
in this module.</dd><dt><a class="constant" href="constant.MAX_CHAINING_LEN.html" title="constant ring::digest::MAX_CHAINING_LEN">MAX_<wbr>CHAINING_<wbr>LEN</a></dt><dd>The maximum chaining length (<a href="struct.Algorithm.html#method.chaining_len" title="method ring::digest::Algorithm::chaining_len"><code>Algorithm::chaining_len()</code></a>) of all the
algorithms in this module.</dd><dt><a class="constant" href="constant.MAX_OUTPUT_LEN.html" title="constant ring::digest::MAX_OUTPUT_LEN">MAX_<wbr>OUTPUT_<wbr>LEN</a></dt><dd>The maximum output length (<a href="struct.Algorithm.html#method.output_len" title="method ring::digest::Algorithm::output_len"><code>Algorithm::output_len()</code></a>) of all the
algorithms in this module.</dd><dt><a class="constant" href="constant.SHA1_OUTPUT_LEN.html" title="constant ring::digest::SHA1_OUTPUT_LEN">SHA1_<wbr>OUTPUT_<wbr>LEN</a></dt><dd>The length of the output of SHA-1, in bytes.</dd><dt><a class="constant" href="constant.SHA256_OUTPUT_LEN.html" title="constant ring::digest::SHA256_OUTPUT_LEN">SHA256_<wbr>OUTPUT_<wbr>LEN</a></dt><dd>The length of the output of SHA-256, in bytes.</dd><dt><a class="constant" href="constant.SHA384_OUTPUT_LEN.html" title="constant ring::digest::SHA384_OUTPUT_LEN">SHA384_<wbr>OUTPUT_<wbr>LEN</a></dt><dd>The length of the output of SHA-384, in bytes.</dd><dt><a class="constant" href="constant.SHA512_256_OUTPUT_LEN.html" title="constant ring::digest::SHA512_256_OUTPUT_LEN">SHA512_<wbr>256_<wbr>OUTPUT_<wbr>LEN</a></dt><dd>The length of the output of SHA-512/256, in bytes.</dd><dt><a class="constant" href="constant.SHA512_OUTPUT_LEN.html" title="constant ring::digest::SHA512_OUTPUT_LEN">SHA512_<wbr>OUTPUT_<wbr>LEN</a></dt><dd>The length of the output of SHA-512, in bytes.</dd></dl><h2 id="statics" class="section-header">Statics<a href="#statics" class="anchor">§</a></h2><dl class="item-table"><dt><a class="static" href="static.SHA1_FOR_LEGACY_USE_ONLY.html" title="static ring::digest::SHA1_FOR_LEGACY_USE_ONLY">SHA1_<wbr>FOR_<wbr>LEGACY_<wbr>USE_<wbr>ONLY</a></dt><dd>SHA-1 as specified in <a href="http://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.180-4.pdf">FIPS 180-4</a>. Deprecated.</dd><dt><a class="static" href="static.SHA256.html" title="static ring::digest::SHA256">SHA256</a></dt><dd>SHA-256 as specified in <a href="http://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.180-4.pdf">FIPS 180-4</a>.</dd><dt><a class="static" href="static.SHA384.html" title="static ring::digest::SHA384">SHA384</a></dt><dd>SHA-384 as specified in <a href="http://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.180-4.pdf">FIPS 180-4</a>.</dd><dt><a class="static" href="static.SHA512.html" title="static ring::digest::SHA512">SHA512</a></dt><dd>SHA-512 as specified in <a href="http://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.180-4.pdf">FIPS 180-4</a>.</dd><dt><a class="static" href="static.SHA512_256.html" title="static ring::digest::SHA512_256">SHA512_<wbr>256</a></dt><dd>SHA-512/256 as specified in <a href="http://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.180-4.pdf">FIPS 180-4</a>.</dd></dl><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><dl class="item-table"><dt><a class="fn" href="fn.digest.html" title="fn ring::digest::digest">digest</a></dt><dd>Returns the digest of <code>data</code> using the given digest algorithm.</dd></dl></section></div></main></body></html>