librustzcash/rustdoc/latest/zcash_proofs/index.html

17 lines
7.1 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="Zcash circuits and proofs."><meta name="keywords" content="rust, rustlang, rust-lang, zcash_proofs"><title>zcash_proofs - 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><script src="../crates.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 crate"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">&#9776;</div><a href='../zcash_proofs/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><h2 class="location">Crate zcash_proofs</h2><div class="block version"><div class="narrow-helper"></div><p>Version 0.5.0</p></div><div class="sidebar-elems"><a id="all-types" href="all.html"><p>See all zcash_proofs's items</p></a><div class="block items"><ul><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#functions">Functions</a></li></ul></div><div id="sidebar-vars" data-name="zcash_proofs" data-ty="mod" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="18" height="18" alt="Pick another theme!" src="../brush.svg"></button><div id="theme-choices" role="menu"></div></div><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" id="help-button" title="help">?</button><a id="settings-menu" href="../settings.html" title="settings"><img width="18" height="18" alt="Change settings" src="../wheel.svg"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Crate <a class="mod" href="#">zcash_proofs</a><button id="copy-path" onclick="copy_path(this)" title="copy path"><img src="../clipboard.svg" width="19" height="18" alt="Copy item import" title="Copy item import to clipboard"></button></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/zcash_proofs/lib.rs.html#1-208" title="goto source code">[src]</a></span></h1><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><em>Zcash circuits and proofs.</em></p>
<p><code>zcash_proofs</code> contains the zk-SNARK circuits used by Zcash, and the APIs for creating
and verifying proofs.</p>
</div></details><h2 id="modules" class="section-header"><a href="#modules">Modules</a></h2>
<div class="item-table"><div class="item-left module-item"><a class="mod" href="circuit/index.html" title="zcash_proofs::circuit mod">circuit</a></div><div class="item-right docblock-short"><p>Implementations of the Zcash circuits and Zcash-specific gadgets.</p>
</div><div class="item-left module-item"><a class="mod" href="constants/index.html" title="zcash_proofs::constants mod">constants</a></div><div class="item-right docblock-short"><p>Various constants used for the Zcash proofs.</p>
</div><div class="item-left module-item"><a class="mod" href="prover/index.html" title="zcash_proofs::prover mod">prover</a><span class="stab portability" title="This is supported on crate features `local-prover` or `bundled-prover` only"><code>local-prover</code> or <code>bundled-prover</code></span></div><div class="item-right docblock-short"><p>Abstractions over the proving system and parameters for ease of use.</p>
</div><div class="item-left module-item"><a class="mod" href="sapling/index.html" title="zcash_proofs::sapling mod">sapling</a></div><div class="item-right docblock-short"><p>Helpers for creating Sapling proofs.</p>
</div><div class="item-left module-item"><a class="mod" href="sprout/index.html" title="zcash_proofs::sprout mod">sprout</a></div><div class="item-right docblock-short"><p>APIs for creating and verifying Sprout proofs.</p>
</div></div><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2>
<div class="item-table"><div class="item-left module-item"><a class="struct" href="struct.ZcashParameters.html" title="zcash_proofs::ZcashParameters struct">ZcashParameters</a></div><div class="item-right docblock-short"></div></div><h2 id="functions" class="section-header"><a href="#functions">Functions</a></h2>
<div class="item-table"><div class="item-left module-item"><a class="fn" href="fn.default_params_folder.html" title="zcash_proofs::default_params_folder fn">default_params_folder</a><span class="stab portability" title="This is supported on crate feature `directories` only"><code>directories</code></span></div><div class="item-right docblock-short"><p>Returns the default folder that the Zcash proving parameters are located in.</p>
</div><div class="item-left module-item"><a class="fn" href="fn.download_parameters.html" title="zcash_proofs::download_parameters fn">download_parameters</a><span class="stab portability" title="This is supported on crate feature `download-params` only"><code>download-params</code></span></div><div class="item-right docblock-short"><p>Download the Zcash Sapling parameters, storing them in the default location.</p>
</div><div class="item-left module-item"><a class="fn" href="fn.load_parameters.html" title="zcash_proofs::load_parameters fn">load_parameters</a></div><div class="item-right docblock-short"></div><div class="item-left module-item"><a class="fn" href="fn.parse_parameters.html" title="zcash_proofs::parse_parameters fn">parse_parameters</a></div><div class="item-right docblock-short"><p>Parse Bls12 keys from bytes as serialized by [<code>Parameters::write</code>].</p>
</div></div></section><section id="search" class="content hidden"></section><div id="rustdoc-vars" data-root-path="../" data-current-crate="zcash_proofs" data-search-index-js="../search-index.js" data-search-js="../search.js"></div>
<script src="../main.js"></script>
</body></html>