10 lines
8.9 KiB
HTML
10 lines
8.9 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="Encoding and decoding functions for Zcash key and address structs."><title>zcash_keys::encoding - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-20739d33.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="zcash_keys" data-themes="" data-resource-suffix="" data-rustdoc-version="1.88.0-nightly (74509131e 2025-04-29)" data-channel="nightly" data-search-js="search-f7877310.js" data-settings-js="settings-5514c975.js" ><script src="../../static.files/storage-4e99c027.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-7ef8a74a.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../zcash_keys/index.html">zcash_<wbr>keys</a><span class="version">0.8.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module encoding</a></h2><h3><a href="#enums">Module Items</a></h3><ul class="block"><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#traits" title="Traits">Traits</a></li><li><a href="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate zcash_<wbr>keys</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">zcash_keys</a></div><h1>Module <span>encoding</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/zcash_keys/encoding.rs.html#1-672">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Encoding and decoding functions for Zcash key and address structs.</p>
|
|
<p>Human-Readable Prefixes (HRPs) for Bech32 encodings are located in the
|
|
[zcash_protocol::constants] module.</p>
|
|
</div></details><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><dl class="item-table"><dt><a class="enum" href="enum.Bech32DecodeError.html" title="enum zcash_keys::encoding::Bech32DecodeError">Bech32<wbr>Decode<wbr>Error</a><wbr><span class="stab portability" title="Available on crate feature `sapling` only"><code>sapling</code></span></dt><dt><a class="enum" href="enum.TransparentCodecError.html" title="enum zcash_keys::encoding::TransparentCodecError">Transparent<wbr>Codec<wbr>Error</a></dt></dl><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><dl class="item-table"><dt><a class="trait" href="trait.AddressCodec.html" title="trait zcash_keys::encoding::AddressCodec">Address<wbr>Codec</a></dt><dd>A trait for encoding and decoding Zcash addresses.</dd></dl><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><dl class="item-table"><dt><a class="fn" href="fn.decode_extended_full_viewing_key.html" title="fn zcash_keys::encoding::decode_extended_full_viewing_key">decode_<wbr>extended_<wbr>full_<wbr>viewing_<wbr>key</a><wbr><span class="stab portability" title="Available on crate feature `sapling` only"><code>sapling</code></span></dt><dd>Decodes an <a href="../keys/sapling/struct.ExtendedFullViewingKey.html" title="struct zcash_keys::keys::sapling::ExtendedFullViewingKey"><code>ExtendedFullViewingKey</code></a> from a Bech32-encoded string, verifying that it matches
|
|
the provided human-readable prefix.</dd><dt><a class="fn" href="fn.decode_extended_spending_key.html" title="fn zcash_keys::encoding::decode_extended_spending_key">decode_<wbr>extended_<wbr>spending_<wbr>key</a><wbr><span class="stab portability" title="Available on crate feature `sapling` only"><code>sapling</code></span></dt><dd>Decodes an <a href="../keys/sapling/struct.ExtendedSpendingKey.html" title="struct zcash_keys::keys::sapling::ExtendedSpendingKey"><code>ExtendedSpendingKey</code></a> from a Bech32-encoded string.</dd><dt><a class="fn" href="fn.decode_extfvk_with_network.html" title="fn zcash_keys::encoding::decode_extfvk_with_network">decode_<wbr>extfvk_<wbr>with_<wbr>network</a><wbr><span class="stab portability" title="Available on crate feature `sapling` only"><code>sapling</code></span></dt><dd>Decodes an <a href="../keys/sapling/struct.ExtendedFullViewingKey.html" title="struct zcash_keys::keys::sapling::ExtendedFullViewingKey"><code>ExtendedFullViewingKey</code></a> and the [<code>NetworkType</code>] that it is intended for use with
|
|
from a Bech32-encoded string.</dd><dt><a class="fn" href="fn.decode_payment_address.html" title="fn zcash_keys::encoding::decode_payment_address">decode_<wbr>payment_<wbr>address</a><wbr><span class="stab portability" title="Available on crate feature `sapling` only"><code>sapling</code></span></dt><dd>Decodes a <a href="sapling::PaymentAddress"><code>PaymentAddress</code></a> from a Bech32-encoded string.</dd><dt><a class="fn" href="fn.decode_transparent_address.html" title="fn zcash_keys::encoding::decode_transparent_address">decode_<wbr>transparent_<wbr>address</a></dt><dd>Decodes a [<code>TransparentAddress</code>] from a Base58Check-encoded string.</dd><dt><a class="fn" href="fn.encode_extended_full_viewing_key.html" title="fn zcash_keys::encoding::encode_extended_full_viewing_key">encode_<wbr>extended_<wbr>full_<wbr>viewing_<wbr>key</a><wbr><span class="stab portability" title="Available on crate feature `sapling` only"><code>sapling</code></span></dt><dd>Writes an <a href="../keys/sapling/struct.ExtendedFullViewingKey.html" title="struct zcash_keys::keys::sapling::ExtendedFullViewingKey"><code>ExtendedFullViewingKey</code></a> as a Bech32-encoded string.</dd><dt><a class="fn" href="fn.encode_extended_spending_key.html" title="fn zcash_keys::encoding::encode_extended_spending_key">encode_<wbr>extended_<wbr>spending_<wbr>key</a><wbr><span class="stab portability" title="Available on crate feature `sapling` only"><code>sapling</code></span></dt><dd>Writes an <a href="../keys/sapling/struct.ExtendedSpendingKey.html" title="struct zcash_keys::keys::sapling::ExtendedSpendingKey"><code>ExtendedSpendingKey</code></a> as a Bech32-encoded string.</dd><dt><a class="fn" href="fn.encode_payment_address.html" title="fn zcash_keys::encoding::encode_payment_address">encode_<wbr>payment_<wbr>address</a><wbr><span class="stab portability" title="Available on crate feature `sapling` only"><code>sapling</code></span></dt><dd>Writes a <a href="sapling::PaymentAddress"><code>PaymentAddress</code></a> as a Bech32-encoded string.</dd><dt><a class="fn" href="fn.encode_payment_address_p.html" title="fn zcash_keys::encoding::encode_payment_address_p">encode_<wbr>payment_<wbr>address_<wbr>p</a><wbr><span class="stab portability" title="Available on crate feature `sapling` only"><code>sapling</code></span></dt><dd>Writes a <a href="sapling::PaymentAddress"><code>PaymentAddress</code></a> as a Bech32-encoded string
|
|
using the human-readable prefix values defined in the specified
|
|
network parameters.</dd><dt><a class="fn" href="fn.encode_transparent_address.html" title="fn zcash_keys::encoding::encode_transparent_address">encode_<wbr>transparent_<wbr>address</a></dt><dd>Writes a [<code>TransparentAddress</code>] as a Base58Check-encoded string.</dd><dt><a class="fn" href="fn.encode_transparent_address_p.html" title="fn zcash_keys::encoding::encode_transparent_address_p">encode_<wbr>transparent_<wbr>address_<wbr>p</a></dt><dd>Writes a [<code>TransparentAddress</code>] as a Base58Check-encoded string.
|
|
using the human-readable prefix values defined in the specified
|
|
network parameters.</dd></dl></section></div></main></body></html> |