8 lines
5.5 KiB
HTML
8 lines
5.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="Trial decryption of the compact note plaintext by the recipient for light clients."><meta name="keywords" content="rust, rustlang, rust-lang, try_compact_note_decryption"><title>try_compact_note_decryption in 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 fn"><!--[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><div class="sidebar-elems"><h2 class="location">Other items in<br><a href="index.html">zcash_note_encryption</a></h2><div id="sidebar-vars" data-name="try_compact_note_decryption" data-ty="fn" 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">Function <a href="index.html">zcash_note_encryption</a>::<wbr><a class="fn" href="#">try_compact_note_decryption</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#458-470" title="goto source code">[src]</a></span></h1><pre class="rust fn">pub fn try_compact_note_decryption<D: <a class="trait" href="trait.Domain.html" title="trait zcash_note_encryption::Domain">Domain</a>, Output: <a class="trait" href="trait.ShieldedOutput.html" title="trait zcash_note_encryption::ShieldedOutput">ShieldedOutput</a><D>>(<br> domain: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>D, <br> ivk: &D::<a class="type" href="trait.Domain.html#associatedtype.IncomingViewingKey" title="type zcash_note_encryption::Domain::IncomingViewingKey">IncomingViewingKey</a>, <br> output: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Output<br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>D::<a class="type" href="trait.Domain.html#associatedtype.Note" title="type zcash_note_encryption::Domain::Note">Note</a>, D::<a class="type" href="trait.Domain.html#associatedtype.Recipient" title="type zcash_note_encryption::Domain::Recipient">Recipient</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>></pre><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Trial decryption of the compact note plaintext by the recipient for light clients.</p>
|
||
<p>Attempts to decrypt and validate the first 52 bytes of <code>enc_ciphertext</code> using the
|
||
given <code>ivk</code>. If successful, the corresponding note is returned, along with the address
|
||
to which the note was sent.</p>
|
||
<p>Implements the procedure specified in <a href="https://zips.z.cash/zip-0307"><code>ZIP 307</code></a>.</p>
|
||
</div></details></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> |