20 lines
9.5 KiB
HTML
20 lines
9.5 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="Implementation of in-band secret distribution abstractions for Zcash transactions. The implementations here provide functionality that is shared between the Sapling and Orchard protocols."><meta name="keywords" content="rust, rustlang, rust-lang, zcash_note_encryption"><title>zcash_note_encryption - 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">☰</div><a href='../zcash_note_encryption/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><h2 class="location">Crate zcash_note_encryption</h2><div class="block version"><div class="narrow-helper"></div><p>Version 0.0.0</p></div><div class="sidebar-elems"><a id="all-types" href="all.html"><p>See all zcash_note_encryption'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="#enums">Enums</a></li><li><a href="#constants">Constants</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li></ul></div><div id="sidebar-vars" data-name="zcash_note_encryption" 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_note_encryption</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">−</span>]</a></span><a class="srclink" href="../src/zcash_note_encryption/lib.rs.html#1-584" 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>Implementation of in-band secret distribution abstractions
|
||
for Zcash transactions. The implementations here provide
|
||
functionality that is shared between the Sapling and Orchard
|
||
protocols.</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="batch/index.html" title="zcash_note_encryption::batch mod">batch</a></div><div class="item-right docblock-short"><p>APIs for batch trial decryption.</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.EphemeralKeyBytes.html" title="zcash_note_encryption::EphemeralKeyBytes struct">EphemeralKeyBytes</a></div><div class="item-right docblock-short"></div><div class="item-left module-item"><a class="struct" href="struct.NoteEncryption.html" title="zcash_note_encryption::NoteEncryption struct">NoteEncryption</a></div><div class="item-right docblock-short"><p>A struct containing context required for encrypting Sapling and Orchard notes.</p>
|
||
</div><div class="item-left module-item"><a class="struct" href="struct.NotePlaintextBytes.html" title="zcash_note_encryption::NotePlaintextBytes struct">NotePlaintextBytes</a></div><div class="item-right docblock-short"></div><div class="item-left module-item"><a class="struct" href="struct.OutPlaintextBytes.html" title="zcash_note_encryption::OutPlaintextBytes struct">OutPlaintextBytes</a></div><div class="item-right docblock-short"></div><div class="item-left module-item"><a class="struct" href="struct.OutgoingCipherKey.html" title="zcash_note_encryption::OutgoingCipherKey struct">OutgoingCipherKey</a></div><div class="item-right docblock-short"><p>A symmetric key that can be used to recover a single Sapling or Orchard output.</p>
|
||
</div></div><h2 id="enums" class="section-header"><a href="#enums">Enums</a></h2>
|
||
<div class="item-table"><div class="item-left module-item"><a class="enum" href="enum.NoteValidity.html" title="zcash_note_encryption::NoteValidity enum">NoteValidity</a></div><div class="item-right docblock-short"></div></div><h2 id="constants" class="section-header"><a href="#constants">Constants</a></h2>
|
||
<div class="item-table"><div class="item-left module-item"><a class="constant" href="constant.AEAD_TAG_SIZE.html" title="zcash_note_encryption::AEAD_TAG_SIZE constant">AEAD_TAG_SIZE</a></div><div class="item-right docblock-short"></div><div class="item-left module-item"><a class="constant" href="constant.COMPACT_NOTE_SIZE.html" title="zcash_note_encryption::COMPACT_NOTE_SIZE constant">COMPACT_NOTE_SIZE</a></div><div class="item-right docblock-short"></div><div class="item-left module-item"><a class="constant" href="constant.ENC_CIPHERTEXT_SIZE.html" title="zcash_note_encryption::ENC_CIPHERTEXT_SIZE constant">ENC_CIPHERTEXT_SIZE</a></div><div class="item-right docblock-short"></div><div class="item-left module-item"><a class="constant" href="constant.NOTE_PLAINTEXT_SIZE.html" title="zcash_note_encryption::NOTE_PLAINTEXT_SIZE constant">NOTE_PLAINTEXT_SIZE</a></div><div class="item-right docblock-short"></div><div class="item-left module-item"><a class="constant" href="constant.OUT_CIPHERTEXT_SIZE.html" title="zcash_note_encryption::OUT_CIPHERTEXT_SIZE constant">OUT_CIPHERTEXT_SIZE</a></div><div class="item-right docblock-short"></div><div class="item-left module-item"><a class="constant" href="constant.OUT_PLAINTEXT_SIZE.html" title="zcash_note_encryption::OUT_PLAINTEXT_SIZE constant">OUT_PLAINTEXT_SIZE</a></div><div class="item-right docblock-short"></div></div><h2 id="traits" class="section-header"><a href="#traits">Traits</a></h2>
|
||
<div class="item-table"><div class="item-left module-item"><a class="trait" href="trait.Domain.html" title="zcash_note_encryption::Domain trait">Domain</a></div><div class="item-right docblock-short"></div><div class="item-left module-item"><a class="trait" href="trait.ShieldedOutput.html" title="zcash_note_encryption::ShieldedOutput trait">ShieldedOutput</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.try_compact_note_decryption.html" title="zcash_note_encryption::try_compact_note_decryption fn">try_compact_note_decryption</a></div><div class="item-right docblock-short"><p>Trial decryption of the compact note plaintext by the recipient for light clients.</p>
|
||
</div><div class="item-left module-item"><a class="fn" href="fn.try_note_decryption.html" title="zcash_note_encryption::try_note_decryption fn">try_note_decryption</a></div><div class="item-right docblock-short"><p>Trial decryption of the full note plaintext by the recipient.</p>
|
||
</div><div class="item-left module-item"><a class="fn" href="fn.try_output_recovery_with_ock.html" title="zcash_note_encryption::try_output_recovery_with_ock fn">try_output_recovery_with_ock</a></div><div class="item-right docblock-short"><p>Recovery of the full note plaintext by the sender.</p>
|
||
</div><div class="item-left module-item"><a class="fn" href="fn.try_output_recovery_with_ovk.html" title="zcash_note_encryption::try_output_recovery_with_ovk fn">try_output_recovery_with_ovk</a></div><div class="item-right docblock-short"><p>Recovery of the full note plaintext by the sender.</p>
|
||
</div></div></section><section id="search" class="content hidden"></section><div id="rustdoc-vars" data-root-path="../" data-current-crate="zcash_note_encryption" data-search-index-js="../search-index.js" data-search-js="../search.js"></div>
|
||
<script src="../main.js"></script>
|
||
</body></html> |