forked from mCaptcha/website
31 lines
No EOL
6.4 KiB
HTML
31 lines
No EOL
6.4 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 `pow_sha256` crate."><meta name="keywords" content="rust, rustlang, rust-lang, pow_sha256"><title>pow_sha256 - 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="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script id="default-settings"></script><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../favicon.svg">
|
||
<link rel="alternate icon" type="image/png" href="../favicon-16x16.png">
|
||
<link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><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">☰</div><a href='../pow_sha256/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><p class="location">Crate pow_sha256</p><div class="block version"><p>Version 0.2.0</p></div><div class="sidebar-elems"><a id="all-types" href="all.html"><p>See all pow_sha256's items</p></a><div class="block items"><ul><li><a href="#structs">Structs</a></li></ul></div><p class="location"></p><script>window.sidebarCurrent = {name: "pow_sha256", ty: "mod", relpath: "../"};</script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||
<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">−</span>]</a></span><a class="srclink" href="../src/pow_sha256/lib.rs.html#1-221" title="goto source code">[src]</a></span><span class="in-band">Crate <a class="mod" href="">pow_sha256</a></span></h1><div class="docblock"><p>MCaptch's SHA256 based Proof of Work library</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">pow_sha256</span>::{<span class="ident">ConfigBuilder</span>, <span class="ident">PoW</span>};
|
||
|
||
<span class="kw">fn</span> <span class="ident">main</span>() {
|
||
<span class="kw">let</span> <span class="ident">config</span> <span class="op">=</span> <span class="ident">ConfigBuilder</span>::<span class="ident">default</span>()
|
||
.<span class="ident">salt</span>(<span class="string">"myrandomsaltisnotlongenoug"</span>.<span class="ident">into</span>())
|
||
.<span class="ident">build</span>()
|
||
.<span class="ident">unwrap</span>();
|
||
|
||
<span class="kw">let</span> <span class="ident">phrase</span> <span class="op">=</span> <span class="string">"ironmansucks"</span>;
|
||
|
||
<span class="kw">const</span> <span class="ident">DIFFICULTY</span>: <span class="ident">u32</span> <span class="op">=</span> <span class="number">1000</span>;
|
||
|
||
<span class="kw">let</span> <span class="ident">work</span> <span class="op">=</span> <span class="ident">config</span>.<span class="ident">prove_work</span>(<span class="kw-2">&</span><span class="ident">phrase</span>, <span class="ident">DIFFICULTY</span>).<span class="ident">unwrap</span>();
|
||
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">config</span>.<span class="ident">is_valid_proof</span>(<span class="kw-2">&</span><span class="ident">work</span>, <span class="kw-2">&</span><span class="ident">phrase</span>));
|
||
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">config</span>.<span class="ident">is_sufficient_difficulty</span>(<span class="kw-2">&</span><span class="ident">work</span>, <span class="ident">DIFFICULTY</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.Config.html" title="pow_sha256::Config struct">Config</a></td><td class="docblock-short"><p>Configuration for generting proof of work
|
||
Please choose a long, unique value for salt
|
||
Resistance to dictionary/rainbow attacks depend on uniqueness
|
||
of the salt</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ConfigBuilder.html" title="pow_sha256::ConfigBuilder struct">ConfigBuilder</a></td><td class="docblock-short"><p>Builder for <a href="struct.Config.html"><code>Config</code></a>.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.PoW.html" title="pow_sha256::PoW struct">PoW</a></td><td class="docblock-short"><p>Proof of Work over concrete type T. T can be any type that implements serde::Serialize.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.PoWBuilder.html" title="pow_sha256::PoWBuilder struct">PoWBuilder</a></td><td class="docblock-short"><p>Builder for <a href="struct.PoW.html"><code>PoW</code></a>.</p>
|
||
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../";window.currentCrate = "pow_sha256";</script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |