132 lines
8.0 KiB
HTML
132 lines
8.0 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="API documentation for the Rust `RollingAdler32` struct in crate `adler32`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, RollingAdler32">
|
||
|
||
<title>adler32::RollingAdler32 - 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 struct">
|
||
<!--[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'>Struct RollingAdler32</p><div class="block items"><ul><li><a href="#methods">Methods</a></li></ul></div><p class='location'><a href='index.html'>adler32</a></p><script>window.sidebarCurrent = {name: 'RollingAdler32', ty: 'struct', 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'>Struct <a href='index.html'>adler32</a>::<wbr><a class="struct" href=''>RollingAdler32</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'>−</span>]
|
||
</a>
|
||
</span><a class='srclink' href='../src/adler32/lib.rs.html#87-90' title='goto source code'>[src]</a></span></h1>
|
||
<pre class='rust struct'>pub struct RollingAdler32 { /* fields omitted */ }</pre><div class='docblock'><p>A rolling version of the Adler32 hash, which can 'forget' past bytes.</p>
|
||
|
||
<p>Calling remove() will update the hash to the value it would have if that
|
||
past byte had never been fed to the algorithm. This allows you to get the
|
||
hash of a rolling window very efficiently.</p>
|
||
</div><h2 id='methods'>Methods</h2><h3 class='impl'><span class='in-band'><code>impl <a class="struct" href="../adler32/struct.RollingAdler32.html" title="struct adler32::RollingAdler32">RollingAdler32</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/adler32/lib.rs.html#92-183' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><code>fn <a href='#method.new' class='fnname'>new</a>() -> <a class="struct" href="../adler32/struct.RollingAdler32.html" title="struct adler32::RollingAdler32">RollingAdler32</a></code></span></h4>
|
||
<div class='docblock'><p>Creates an empty Adler32 context (with hash 1).</p>
|
||
</div><h4 id='method.from_value' class="method"><span id='from_value.v' class='invisible'><code>fn <a href='#method.from_value' class='fnname'>from_value</a>(adler32: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="struct" href="../adler32/struct.RollingAdler32.html" title="struct adler32::RollingAdler32">RollingAdler32</a></code></span></h4>
|
||
<div class='docblock'><p>Creates an Adler32 context with the given initial value.</p>
|
||
</div><h4 id='method.from_buffer' class="method"><span id='from_buffer.v' class='invisible'><code>fn <a href='#method.from_buffer' class='fnname'>from_buffer</a>(buffer: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -> <a class="struct" href="../adler32/struct.RollingAdler32.html" title="struct adler32::RollingAdler32">RollingAdler32</a></code></span></h4>
|
||
<div class='docblock'><p>Convenience function initializing a context from the hash of a buffer.</p>
|
||
</div><h4 id='method.hash' class="method"><span id='hash.v' class='invisible'><code>fn <a href='#method.hash' class='fnname'>hash</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code></span></h4>
|
||
<div class='docblock'><p>Returns the current hash.</p>
|
||
</div><h4 id='method.remove' class="method"><span id='remove.v' class='invisible'><code>fn <a href='#method.remove' class='fnname'>remove</a>(&mut self, size: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, byte: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>)</code></span></h4>
|
||
<div class='docblock'><p>Removes the given <code>byte</code> that was fed to the algorithm <code>size</code> bytes ago.</p>
|
||
</div><h4 id='method.update' class="method"><span id='update.v' class='invisible'><code>fn <a href='#method.update' class='fnname'>update</a>(&mut self, byte: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>)</code></span></h4>
|
||
<div class='docblock'><p>Feeds a new <code>byte</code> to the algorithm to update the hash.</p>
|
||
</div><h4 id='method.update_buffer' class="method"><span id='update_buffer.v' class='invisible'><code>fn <a href='#method.update_buffer' class='fnname'>update_buffer</a>(&mut self, buffer: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>)</code></span></h4>
|
||
<div class='docblock'><p>Feeds a vector of bytes to the algorithm to update the hash.</p>
|
||
</div></div></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>⇤</dt>
|
||
<dd>Move up in search results</dd>
|
||
<dt>⇥</dt>
|
||
<dd>Move down in search results</dd>
|
||
<dt>⏎</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 = "adler32";
|
||
</script>
|
||
<script src="../main.js"></script>
|
||
<script defer src="../search-index.js"></script>
|
||
</body>
|
||
</html> |