mirror of
https://gitlab.redox-os.org/CoffeeCode/redox-ssh.git
synced 2025-12-28 22:32:18 +01:00
161 lines
No EOL
11 KiB
HTML
161 lines
No EOL
11 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 `Context` struct in crate `ring`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, Context">
|
||
|
||
<title>ring::digest::Context - 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 Context</p><div class="block items"><ul><li><a href="#fields">Fields</a></li><li><a href="#methods">Methods</a></li><li><a href="#implementations">Trait Implementations</a></li></ul></div><p class='location'><a href='../index.html'>ring</a>::<wbr><a href='index.html'>digest</a></p><script>window.sidebarCurrent = {name: 'Context', 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'>ring</a>::<wbr><a href='index.html'>digest</a>::<wbr><a class="struct" href=''>Context</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/ring/digest/digest.rs.html#59-73' title='goto source code'>[src]</a></span></h1>
|
||
<pre class='rust struct'>pub struct Context {
|
||
pub algorithm: &'static <a class="struct" href="../../ring/digest/struct.Algorithm.html" title="struct ring::digest::Algorithm">Algorithm</a>,
|
||
// some fields omitted
|
||
}</pre><div class='docblock'><p>A context for multi-step (Init-Update-Finish) digest calculations.</p>
|
||
|
||
<p>C analog: <code>EVP_MD_CTX</code>.</p>
|
||
|
||
<h1 id='examples' class='section-header'><a href='#examples'>Examples</a></h1>
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">ring</span>::<span class="ident">digest</span>;
|
||
|
||
<span class="kw">let</span> <span class="ident">one_shot</span> <span class="op">=</span> <span class="ident">digest</span>::<span class="ident">digest</span>(<span class="kw-2">&</span><span class="ident">digest</span>::<span class="ident">SHA384</span>, <span class="string">b"hello, world"</span>);
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">ctx</span> <span class="op">=</span> <span class="ident">digest</span>::<span class="ident">Context</span>::<span class="ident">new</span>(<span class="kw-2">&</span><span class="ident">digest</span>::<span class="ident">SHA384</span>);
|
||
<span class="ident">ctx</span>.<span class="ident">update</span>(<span class="string">b"hello"</span>);
|
||
<span class="ident">ctx</span>.<span class="ident">update</span>(<span class="string">b", "</span>);
|
||
<span class="ident">ctx</span>.<span class="ident">update</span>(<span class="string">b"world"</span>);
|
||
<span class="kw">let</span> <span class="ident">multi_part</span> <span class="op">=</span> <span class="ident">ctx</span>.<span class="ident">finish</span>();
|
||
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="kw-2">&</span><span class="ident">one_shot</span>.<span class="ident">as_ref</span>(), <span class="kw-2">&</span><span class="ident">multi_part</span>.<span class="ident">as_ref</span>());</pre>
|
||
</div><h2 id='fields' class='fields'>Fields</h2><span id='structfield.algorithm' class="structfield">
|
||
<span id='algorithm.v' class='invisible'>
|
||
<code>algorithm: &'static <a class="struct" href="../../ring/digest/struct.Algorithm.html" title="struct ring::digest::Algorithm">Algorithm</a></code>
|
||
</span></span><div class='docblock'><p>The context's algorithm.</p>
|
||
</div><h2 id='methods'>Methods</h2><h3 class='impl'><span class='in-band'><code>impl <a class="struct" href="../../ring/digest/struct.Context.html" title="struct ring::digest::Context">Context</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ring/digest/digest.rs.html#75-196' 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>(algorithm: &'static <a class="struct" href="../../ring/digest/struct.Algorithm.html" title="struct ring::digest::Algorithm">Algorithm</a>) -> <a class="struct" href="../../ring/digest/struct.Context.html" title="struct ring::digest::Context">Context</a></code></span></h4>
|
||
<div class='docblock'><p>Constructs a new context.</p>
|
||
|
||
<p>C analogs: <code>EVP_DigestInit</code>, <code>EVP_DigestInit_ex</code></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, data: <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>Updates the digest with all the data in <code>data</code>. <code>update</code> may be called
|
||
zero or more times until <code>finish</code> is called. It must not be called
|
||
after <code>finish</code> has been called.</p>
|
||
|
||
<p>C analog: <code>EVP_DigestUpdate</code></p>
|
||
</div><h4 id='method.finish' class="method"><span id='finish.v' class='invisible'><code>fn <a href='#method.finish' class='fnname'>finish</a>(self) -> <a class="struct" href="../../ring/digest/struct.Digest.html" title="struct ring::digest::Digest">Digest</a></code></span></h4>
|
||
<div class='docblock'><p>Finalizes the digest calculation and returns the digest value. <code>finish</code>
|
||
consumes the context so it cannot be (mis-)used after <code>finish</code> has been
|
||
called.</p>
|
||
|
||
<p>C analogs: <code>EVP_DigestFinal</code>, <code>EVP_DigestFinal_ex</code></p>
|
||
</div><h4 id='method.algorithm' class="method"><span id='algorithm.v-1' class='invisible'><code>fn <a href='#method.algorithm' class='fnname'>algorithm</a>(&self) -> &'static <a class="struct" href="../../ring/digest/struct.Algorithm.html" title="struct ring::digest::Algorithm">Algorithm</a></code></span></h4>
|
||
<div class='docblock'><p>The algorithm that this context is using.</p>
|
||
</div></div><h2 id='implementations'>Trait Implementations</h2><h3 class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="../../ring/digest/struct.Context.html" title="struct ring::digest::Context">Context</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ring/digest/digest.rs.html#200-210' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&self) -> <a class="struct" href="../../ring/digest/struct.Context.html" title="struct ring::digest::Context">Context</a></code></span></h4>
|
||
<div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
|
||
</div><h4 id='method.clone_from' class="method"><span id='clone_from.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&mut self, source: &Self)</code><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div></span></h4>
|
||
<div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></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 = "ring";
|
||
</script>
|
||
<script src="../../jquery.js"></script>
|
||
<script src="../../main.js"></script>
|
||
<script defer src="../../search-index.js"></script>
|
||
</body>
|
||
</html> |