1
0
Fork 0
mirror of https://gitlab.redox-os.org/CoffeeCode/redox-ssh.git synced 2025-12-28 20:42:18 +01:00
redox-ssh/ring/digest/index.html

244 lines
No EOL
12 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">
<link rel="stylesheet" type="text/css" href="../../main.css">
</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">
<p class='location'>Module digest</p><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><script>window.sidebarCurrent = {name: 'digest', ty: 'mod', 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'>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/digest.rs.html#15-583' 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='struct ring::digest::Algorithm'>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='struct ring::digest::Context'>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='struct ring::digest::Digest'>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='constant ring::digest::MAX_BLOCK_LEN'>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='constant ring::digest::MAX_CHAINING_LEN'>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='constant ring::digest::MAX_OUTPUT_LEN'>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='constant ring::digest::SHA1_OUTPUT_LEN'>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='constant ring::digest::SHA256_OUTPUT_LEN'>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='constant ring::digest::SHA384_OUTPUT_LEN'>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='constant ring::digest::SHA512_256_OUTPUT_LEN'>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='constant ring::digest::SHA512_OUTPUT_LEN'>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.html"
title='static ring::digest::SHA1'>SHA1</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='static ring::digest::SHA256'>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='static ring::digest::SHA384'>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='static ring::digest::SHA512'>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='static ring::digest::SHA512_256'>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='fn ring::digest::digest'>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>
<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>&larrb;</dt>
<dd>Move up in search results</dd>
<dt>&rarrb;</dt>
<dd>Move down in search results</dd>
<dt>&#9166;</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 = "ring";
</script>
<script src="../../jquery.js"></script>
<script src="../../main.js"></script>
<script defer src="../../search-index.js"></script>
</body>
</html>