38 lines
17 KiB
HTML
38 lines
17 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 helper trait for converting a `ZcashAddress` into another type."><meta name="keywords" content="rust, rustlang, rust-lang, FromAddress"><title>FromAddress in zcash_address - 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 trait"><!--[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_address/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><h2 class="location">Trait FromAddress</h2><div class="sidebar-elems"><div class="block items"><h3 class="sidebar-title"><a href="#provided-methods">Provided Methods</a></h3><div class="sidebar-links"><a href="#method.from_sapling">from_sapling</a><a href="#method.from_sprout">from_sprout</a><a href="#method.from_transparent_p2pkh">from_transparent_p2pkh</a><a href="#method.from_transparent_p2sh">from_transparent_p2sh</a><a href="#method.from_unified">from_unified</a></div><h3 class="sidebar-title"><a href="#implementors">Implementors</a></h3></div><h2 class="location">Other items in<br><a href="index.html">zcash_address</a></h2><div id="sidebar-vars" data-name="FromAddress" data-ty="trait" 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">Trait <a href="index.html">zcash_address</a>::<wbr><a class="trait" href="#">FromAddress</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_address/convert.rs.html#51-76" title="goto source code">[src]</a></span></h1><div class="docblock type-decl"><pre class="rust trait">pub trait FromAddress: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> {
|
||
fn <a href="#method.from_sprout" class="fnname">from_sprout</a>(<br> net: <a class="enum" href="enum.Network.html" title="enum zcash_address::Network">Network</a>, <br> data: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; 64]</a><br> ) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, <a class="struct" href="struct.UnsupportedAddress.html" title="struct zcash_address::UnsupportedAddress">UnsupportedAddress</a>> { ... }
|
||
<div class="item-spacer"></div> fn <a href="#method.from_sapling" class="fnname">from_sapling</a>(<br> net: <a class="enum" href="enum.Network.html" title="enum zcash_address::Network">Network</a>, <br> data: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; 43]</a><br> ) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, <a class="struct" href="struct.UnsupportedAddress.html" title="struct zcash_address::UnsupportedAddress">UnsupportedAddress</a>> { ... }
|
||
<div class="item-spacer"></div> fn <a href="#method.from_unified" class="fnname">from_unified</a>(<br> net: <a class="enum" href="enum.Network.html" title="enum zcash_address::Network">Network</a>, <br> data: <a class="struct" href="unified/struct.Address.html" title="struct zcash_address::unified::Address">Address</a><br> ) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, <a class="struct" href="struct.UnsupportedAddress.html" title="struct zcash_address::UnsupportedAddress">UnsupportedAddress</a>> { ... }
|
||
<div class="item-spacer"></div> fn <a href="#method.from_transparent_p2pkh" class="fnname">from_transparent_p2pkh</a>(<br> net: <a class="enum" href="enum.Network.html" title="enum zcash_address::Network">Network</a>, <br> data: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; 20]</a><br> ) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, <a class="struct" href="struct.UnsupportedAddress.html" title="struct zcash_address::UnsupportedAddress">UnsupportedAddress</a>> { ... }
|
||
<div class="item-spacer"></div> fn <a href="#method.from_transparent_p2sh" class="fnname">from_transparent_p2sh</a>(<br> net: <a class="enum" href="enum.Network.html" title="enum zcash_address::Network">Network</a>, <br> data: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; 20]</a><br> ) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, <a class="struct" href="struct.UnsupportedAddress.html" title="struct zcash_address::UnsupportedAddress">UnsupportedAddress</a>> { ... }
|
||
}</pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A helper trait for converting a <a href="struct.ZcashAddress.html"><code>ZcashAddress</code></a> into another type.</p>
|
||
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">zcash_address</span>::{<span class="ident">FromAddress</span>, <span class="ident">Network</span>, <span class="ident">UnsupportedAddress</span>, <span class="ident">ZcashAddress</span>};
|
||
|
||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>)]</span>
|
||
<span class="kw">struct</span> <span class="ident">MySapling</span>([<span class="ident">u8</span>; <span class="number">43</span>]);
|
||
|
||
<span class="comment">// Implement the FromAddress trait, overriding whichever conversion methods match your</span>
|
||
<span class="comment">// requirements for the resulting type.</span>
|
||
<span class="kw">impl</span> <span class="ident">FromAddress</span> <span class="kw">for</span> <span class="ident">MySapling</span> {
|
||
<span class="kw">fn</span> <span class="ident">from_sapling</span>(<span class="ident">net</span>: <span class="ident">Network</span>, <span class="ident">data</span>: [<span class="ident">u8</span>; <span class="number">43</span>]) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="self">Self</span>, <span class="ident">UnsupportedAddress</span><span class="op">></span> {
|
||
<span class="prelude-val">Ok</span>(<span class="ident">MySapling</span>(<span class="ident">data</span>))
|
||
}
|
||
}
|
||
|
||
<span class="comment">// For a supported address type, the conversion works.</span>
|
||
<span class="kw">let</span> <span class="ident">addr</span>: <span class="ident">ZcashAddress</span> <span class="op">=</span>
|
||
<span class="string">"zs1qqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqpq6d8g"</span>
|
||
.<span class="ident">parse</span>()
|
||
.<span class="ident">unwrap</span>();
|
||
<span class="macro">assert!</span>(<span class="ident">addr</span>.<span class="ident">convert</span>::<span class="op"><</span><span class="ident">MySapling</span><span class="op">></span>().<span class="ident">is_ok</span>());
|
||
|
||
<span class="comment">// For an unsupported address type, we get an error.</span>
|
||
<span class="kw">let</span> <span class="ident">addr</span>: <span class="ident">ZcashAddress</span> <span class="op">=</span> <span class="string">"t1Hsc1LR8yKnbbe3twRp88p6vFfC5t7DLbs"</span>.<span class="ident">parse</span>().<span class="ident">unwrap</span>();
|
||
<span class="macro">assert_eq!</span>(
|
||
<span class="ident">addr</span>.<span class="ident">convert</span>::<span class="op"><</span><span class="ident">MySapling</span><span class="op">></span>().<span class="ident">unwrap_err</span>().<span class="ident">to_string</span>(),
|
||
<span class="string">"Zcash transparent P2PKH addresses are not supported"</span>,
|
||
);</pre></div>
|
||
</div></details><h2 id="provided-methods" class="small-section-header">Provided methods<a href="#provided-methods" class="anchor"></a></h2><div class="methods"><div id="method.from_sprout" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/zcash_address/convert.rs.html#52-55" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#method.from_sprout" class="fnname">from_sprout</a>(net: <a class="enum" href="enum.Network.html" title="enum zcash_address::Network">Network</a>, data: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; 64]</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, <a class="struct" href="struct.UnsupportedAddress.html" title="struct zcash_address::UnsupportedAddress">UnsupportedAddress</a>></h4></div><div id="method.from_sapling" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/zcash_address/convert.rs.html#57-60" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#method.from_sapling" class="fnname">from_sapling</a>(<br> net: <a class="enum" href="enum.Network.html" title="enum zcash_address::Network">Network</a>, <br> data: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; 43]</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, <a class="struct" href="struct.UnsupportedAddress.html" title="struct zcash_address::UnsupportedAddress">UnsupportedAddress</a>></h4></div><div id="method.from_unified" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/zcash_address/convert.rs.html#62-65" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#method.from_unified" class="fnname">from_unified</a>(net: <a class="enum" href="enum.Network.html" title="enum zcash_address::Network">Network</a>, data: <a class="struct" href="unified/struct.Address.html" title="struct zcash_address::unified::Address">Address</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, <a class="struct" href="struct.UnsupportedAddress.html" title="struct zcash_address::UnsupportedAddress">UnsupportedAddress</a>></h4></div><div id="method.from_transparent_p2pkh" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/zcash_address/convert.rs.html#67-70" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#method.from_transparent_p2pkh" class="fnname">from_transparent_p2pkh</a>(<br> net: <a class="enum" href="enum.Network.html" title="enum zcash_address::Network">Network</a>, <br> data: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; 20]</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, <a class="struct" href="struct.UnsupportedAddress.html" title="struct zcash_address::UnsupportedAddress">UnsupportedAddress</a>></h4></div><div id="method.from_transparent_p2sh" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/zcash_address/convert.rs.html#72-75" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#method.from_transparent_p2sh" class="fnname">from_transparent_p2sh</a>(<br> net: <a class="enum" href="enum.Network.html" title="enum zcash_address::Network">Network</a>, <br> data: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; 20]</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, <a class="struct" href="struct.UnsupportedAddress.html" title="struct zcash_address::UnsupportedAddress">UnsupportedAddress</a>></h4></div></div><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"></div><script type="text/javascript" src="../implementors/zcash_address/trait.FromAddress.js" async></script></section><section id="search" class="content hidden"></section><div id="rustdoc-vars" data-root-path="../" data-current-crate="zcash_address" data-search-index-js="../search-index.js" data-search-js="../search.js"></div>
|
||
<script src="../main.js"></script>
|
||
</body></html> |