22 lines
6.4 KiB
HTML
22 lines
6.4 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="Returns the balance for the account, including all mined unspent notes that we know about."><meta name="keywords" content="rust, rustlang, rust-lang, get_balance"><title>get_balance in zcash_client_sqlite::wallet - 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_client_sqlite/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_client_sqlite</a>::<wbr><a href="index.html">wallet</a></h2><div id="sidebar-vars" data-name="get_balance" 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_client_sqlite</a>::<wbr><a href="index.html">wallet</a>::<wbr><a class="fn" href="#">get_balance</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_client_sqlite/wallet.rs.html#216-231" title="goto source code">[src]</a></span></h1><pre class="rust fn">pub fn get_balance<P>(<br> wdb: &<a class="struct" href="../struct.WalletDb.html" title="struct zcash_client_sqlite::WalletDb">WalletDb</a><P>, <br> account: <a class="struct" href="../../zcash_client_backend/wallet/struct.AccountId.html" title="struct zcash_client_backend::wallet::AccountId">AccountId</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../../zcash_primitives/transaction/components/amount/struct.Amount.html" title="struct zcash_primitives::transaction::components::amount::Amount">Amount</a>, <a class="enum" href="../error/enum.SqliteClientError.html" title="enum zcash_client_sqlite::error::SqliteClientError">SqliteClientError</a>></pre><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Returns the balance for the account, including all mined unspent notes that we know
|
||
about.</p>
|
||
<p>WARNING: This balance is potentially unreliable, as mined notes may become unmined due
|
||
to chain reorgs. You should generally not show this balance to users without some
|
||
caveat. Use <a href="fn.get_balance_at.html" title="get_balance_at"><code>get_balance_at</code></a> where you need a more reliable indication of the
|
||
wallet balance.</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">tempfile::NamedTempFile</span>;
|
||
<span class="kw">use</span> <span class="ident">zcash_primitives::consensus::Network</span>;
|
||
<span class="kw">use</span> <span class="ident">zcash_client_backend::wallet::AccountId</span>;
|
||
<span class="kw">use</span> <span class="ident">zcash_client_sqlite</span>::{
|
||
<span class="ident">WalletDb</span>,
|
||
<span class="ident">wallet::get_balance</span>,
|
||
};
|
||
|
||
<span class="kw">let</span> <span class="ident">data_file</span> <span class="op">=</span> <span class="ident">NamedTempFile::new</span>().<span class="ident">unwrap</span>();
|
||
<span class="kw">let</span> <span class="ident">db</span> <span class="op">=</span> <span class="ident">WalletDb::for_path</span>(<span class="ident">data_file</span>, <span class="ident">Network::TestNetwork</span>).<span class="ident">unwrap</span>();
|
||
<span class="kw">let</span> <span class="ident">addr</span> <span class="op">=</span> <span class="ident">get_balance</span>(<span class="kw-2">&</span><span class="ident">db</span>, <span class="ident">AccountId</span>(<span class="number">0</span>));</pre></div>
|
||
</div></details></section><section id="search" class="content hidden"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="zcash_client_sqlite" data-search-index-js="../../search-index.js" data-search-js="../../search.js"></div>
|
||
<script src="../../main.js"></script>
|
||
</body></html> |