28 lines
13 KiB
HTML
28 lines
13 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="A trait for encoding and decoding Zcash addresses."><title>AddressCodec in zcash_client_backend::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-1a91846b.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="zcash_client_backend" data-themes="" data-resource-suffix="" data-rustdoc-version="1.88.0-nightly (27d6200a7 2025-05-06)" 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 trait"><!--[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_client_backend/index.html">zcash_<wbr>client_<wbr>backend</a><span class="version">0.18.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Address<wbr>Codec</a></h2><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.Error" title="Error">Error</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.decode" title="decode">decode</a></li><li><a href="#tymethod.encode" title="encode">encode</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-AddressCodec%3CP%3E-for-PaymentAddress" title="PaymentAddress">PaymentAddress</a></li><li><a href="#impl-AddressCodec%3CP%3E-for-TransparentAddress" title="TransparentAddress">TransparentAddress</a></li></ul><h3><a href="#dyn-compatibility">Dyn Compatibility</a></h3><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In zcash_<wbr>client_<wbr>backend::<wbr>encoding</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_client_backend</a>::<wbr><a href="index.html">encoding</a></div><h1>Trait <span class="trait">AddressCodec</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"></span></div><pre class="rust item-decl"><code>pub trait AddressCodec<P>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> {
|
|
type <a href="#associatedtype.Error" class="associatedtype">Error</a>;
|
|
|
|
// Required methods
|
|
fn <a href="#tymethod.encode" class="fn">encode</a>(&self, params: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&P</a>) -> <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.decode" class="fn">decode</a>(params: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&P</a>, address: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, Self::<a class="associatedtype" href="trait.AddressCodec.html#associatedtype.Error" title="type zcash_client_backend::encoding::AddressCodec::Error">Error</a>>;
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A trait for encoding and decoding Zcash addresses.</p>
|
|
</div></details><h2 id="required-associated-types" class="section-header">Required Associated Types<a href="#required-associated-types" class="anchor">§</a></h2><div class="methods"><section id="associatedtype.Error" class="method"><h4 class="code-header">type <a href="#associatedtype.Error" class="associatedtype">Error</a></h4></section></div><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.encode" class="method"><h4 class="code-header">fn <a href="#tymethod.encode" class="fn">encode</a>(&self, params: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&P</a>) -> <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></h4></section></summary><div class="docblock"><p>Encode a Zcash address.</p>
|
|
<h5 id="arguments"><a class="doc-anchor" href="#arguments">§</a>Arguments</h5>
|
|
<ul>
|
|
<li><code>params</code> - The network the address is to be used on.</li>
|
|
</ul>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.decode" class="method"><h4 class="code-header">fn <a href="#tymethod.decode" class="fn">decode</a>(params: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&P</a>, address: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, Self::<a class="associatedtype" href="trait.AddressCodec.html#associatedtype.Error" title="type zcash_client_backend::encoding::AddressCodec::Error">Error</a>></h4></section></summary><div class="docblock"><p>Decodes a Zcash address from its string representation.</p>
|
|
<h5 id="arguments-1"><a class="doc-anchor" href="#arguments-1">§</a>Arguments</h5>
|
|
<ul>
|
|
<li><code>params</code> - The network the address is to be used on.</li>
|
|
<li><code>address</code> - The string representation of the address.</li>
|
|
</ul>
|
|
</div></details></div><h2 id="dyn-compatibility" class="section-header">Dyn Compatibility<a href="#dyn-compatibility" class="anchor">§</a></h2><div class="dyn-compatibility-info"><p>This trait is <b>not</b> <a href="https://doc.rust-lang.org/nightly/reference/items/traits.html#dyn-compatibility">dyn compatible</a>.</p><p><i>In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.</i></p></div><h2 id="foreign-impls" class="section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><details class="toggle implementors-toggle"><summary><section id="impl-AddressCodec%3CP%3E-for-PaymentAddress" class="impl"><a href="#impl-AddressCodec%3CP%3E-for-PaymentAddress" class="anchor">§</a><h3 class="code-header">impl<P> <a class="trait" href="trait.AddressCodec.html" title="trait zcash_client_backend::encoding::AddressCodec">AddressCodec</a><P> for PaymentAddress<div class="where">where
|
|
P: Parameters,</div></h3></section></summary><div class="impl-items"><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="enum.Bech32DecodeError.html" title="enum zcash_client_backend::encoding::Bech32DecodeError">Bech32DecodeError</a></h4></section><section id="method.encode" class="method trait-impl"><a href="#method.encode" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.encode" class="fn">encode</a>(&self, params: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&P</a>) -> <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></h4></section><section id="method.decode" class="method trait-impl"><a href="#method.decode" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.decode" class="fn">decode</a>(
|
|
params: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&P</a>,
|
|
address: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>,
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><PaymentAddress, <a class="enum" href="enum.Bech32DecodeError.html" title="enum zcash_client_backend::encoding::Bech32DecodeError">Bech32DecodeError</a>></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-AddressCodec%3CP%3E-for-TransparentAddress" class="impl"><a href="#impl-AddressCodec%3CP%3E-for-TransparentAddress" class="anchor">§</a><h3 class="code-header">impl<P> <a class="trait" href="trait.AddressCodec.html" title="trait zcash_client_backend::encoding::AddressCodec">AddressCodec</a><P> for TransparentAddress<div class="where">where
|
|
P: Parameters,</div></h3></section></summary><div class="impl-items"><section id="associatedtype.Error-2" class="associatedtype trait-impl"><a href="#associatedtype.Error-2" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="enum.TransparentCodecError.html" title="enum zcash_client_backend::encoding::TransparentCodecError">TransparentCodecError</a></h4></section><section id="method.encode-1" class="method trait-impl"><a href="#method.encode-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.encode" class="fn">encode</a>(&self, params: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&P</a>) -> <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></h4></section><section id="method.decode-1" class="method trait-impl"><a href="#method.decode-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.decode" class="fn">decode</a>(
|
|
params: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&P</a>,
|
|
address: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>,
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><TransparentAddress, <a class="enum" href="enum.TransparentCodecError.html" title="enum zcash_client_backend::encoding::TransparentCodecError">TransparentCodecError</a>></h4></section></div></details><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><details class="toggle implementors-toggle"><summary><section id="impl-AddressCodec%3CP%3E-for-UnifiedAddress" class="impl"><a href="#impl-AddressCodec%3CP%3E-for-UnifiedAddress" class="anchor">§</a><h3 class="code-header">impl<P> <a class="trait" href="trait.AddressCodec.html" title="trait zcash_client_backend::encoding::AddressCodec">AddressCodec</a><P> for <a class="struct" href="../address/struct.UnifiedAddress.html" title="struct zcash_client_backend::address::UnifiedAddress">UnifiedAddress</a><div class="where">where
|
|
P: Parameters,</div></h3></section></summary><div class="impl-items"><section id="associatedtype.Error-3" class="associatedtype trait-impl"><a href="#associatedtype.Error-3" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Error" class="associatedtype">Error</a> = <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></h4></section></div></details></div><script src="../../trait.impl/zcash_keys/encoding/trait.AddressCodec.js" data-ignore-extern-crates="zcash_transparent,sapling_crypto,zcash_keys" async></script></section></div></main></body></html> |