26 lines
6.7 KiB
HTML
Raw Normal View History

2019-09-06 15:57:44 -07:00
<!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 `blake2bp` mod in crate `blake2b_simd`."><meta name="keywords" content="rust, rustlang, rust-lang, blake2bp"><title>blake2b_simd::blake2bp - 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="../../dark.css"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="shortcut icon" href="../../favicon.ico"><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='../../blake2b_simd/index.html'><div class='logo-container'><img src='../../rust-logo.png' alt='logo'></div></a><p class='location'>Module blake2bp</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'><a href='../index.html'>blake2b_simd</a></p><script>window.sidebarCurrent = {name: 'blake2bp', ty: 'mod', relpath: '../'};</script><script defer src="../sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press S to search, ? for more options…" type="search"></div><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='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/blake2b_simd/blake2bp.rs.html#1-570' title='goto source code'>[src]</a></span><span class='in-band'>Module <a href='../index.html'>blake2b_simd</a>::<wbr><a class="mod" href=''>blake2bp</a></span></h1><div class='docblock'><p>BLAKE2bp, a variant of BLAKE2b that uses SIMD more efficiently.</p>
<p>The AVX2 implementation of BLAKE2bp is about twice as fast that of BLAKE2b.
However, note that it's a different hash function, and it gives a different
hash from BLAKE2b for the same input.</p>
<h1 id="example" class="section-header"><a href="#example">Example</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">blake2b_simd</span>::<span class="ident">blake2bp</span>;
<span class="kw">let</span> <span class="ident">hash</span> <span class="op">=</span> <span class="ident">blake2bp</span>::<span class="ident">Params</span>::<span class="ident">new</span>()
.<span class="ident">hash_length</span>(<span class="number">16</span>)
.<span class="ident">key</span>(<span class="string">b&quot;The Magic Words are Squeamish Ossifrage&quot;</span>)
.<span class="ident">to_state</span>()
.<span class="ident">update</span>(<span class="string">b&quot;foo&quot;</span>)
.<span class="ident">update</span>(<span class="string">b&quot;bar&quot;</span>)
.<span class="ident">update</span>(<span class="string">b&quot;baz&quot;</span>)
.<span class="ident">finalize</span>();
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="string">&quot;e69c7d2c42a5ac14948772231c68c552&quot;</span>, <span class="kw-2">&amp;</span><span class="ident">hash</span>.<span class="ident">to_hex</span>());</pre></div>
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table><tr class='module-item'><td><a class="struct" href="struct.Params.html" title='blake2b_simd::blake2bp::Params struct'>Params</a></td><td class='docblock-short'><p>A parameter builder for BLAKE2bp, just like the <a href="../struct.Params.html"><code>Params</code></a> type for
BLAKE2b.</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.State.html" title='blake2b_simd::blake2bp::State struct'>State</a></td><td class='docblock-short'><p>An incremental hasher for BLAKE2bp, just like the <a href="../struct.State.html"><code>State</code></a> type for
BLAKE2b.</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.blake2bp.html" title='blake2b_simd::blake2bp::blake2bp fn'>blake2bp</a></td><td class='docblock-short'><p>Compute the BLAKE2bp hash of a slice of bytes all at once, using default
parameters.</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><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd></kbd></dt><dd>Move up in search results</dd><dt><kbd></kbd></dt><dd>Move down in search results</dd><dt><kbd></kbd></dt><dd>Switch tab</dd><dt><kbd>&#9166;</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse 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><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../";window.currentCrate = "blake2b_simd";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>