16 lines
8.9 KiB
HTML
16 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="API documentation for the Rust `service` mod in crate `zcash_client_backend`."><title>zcash_client_backend::proto::service - 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-84e720fa.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.89.0-nightly (ccf3198de 2025-06-05)" 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-fd3af306.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-32bb7600.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_client_backend/index.html">zcash_<wbr>client_<wbr>backend</a><span class="version">0.19.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module service</a></h2><h3><a href="#modules">Module Items</a></h3><ul class="block"><li><a href="#modules" title="Modules">Modules</a></li><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="../index.html">In zcash_<wbr>client_<wbr>backend::<wbr>proto</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></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">proto</a></div><h1>Module <span>service</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_client_backend/proto/service.rs.html#2-901">Source</a> </span></div><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><dl class="item-table"><dt><a class="mod" href="compact_tx_streamer_client/index.html" title="mod zcash_client_backend::proto::service::compact_tx_streamer_client">compact_<wbr>tx_<wbr>streamer_<wbr>client</a><wbr><span class="stab portability" title="Available on crate feature `lightwalletd-tonic` only"><code>lightwalletd-tonic</code></span></dt><dd>Generated client implementations.</dd></dl><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.Address.html" title="struct zcash_client_backend::proto::service::Address">Address</a></dt><dt><a class="struct" href="struct.AddressList.html" title="struct zcash_client_backend::proto::service::AddressList">Address<wbr>List</a></dt><dt><a class="struct" href="struct.Balance.html" title="struct zcash_client_backend::proto::service::Balance">Balance</a></dt><dt><a class="struct" href="struct.BlockId.html" title="struct zcash_client_backend::proto::service::BlockId">BlockId</a></dt><dd>A BlockID message contains identifiers to select a block: a height or a
|
|
hash. Specification by hash is not implemented, but may be in the future.</dd><dt><a class="struct" href="struct.BlockRange.html" title="struct zcash_client_backend::proto::service::BlockRange">Block<wbr>Range</a></dt><dd>BlockRange specifies a series of blocks from start to end inclusive.
|
|
Both BlockIDs must be heights; specification by hash is not yet supported.</dd><dt><a class="struct" href="struct.ChainSpec.html" title="struct zcash_client_backend::proto::service::ChainSpec">Chain<wbr>Spec</a></dt><dd>Chainspec is a placeholder to allow specification of a particular chain fork.</dd><dt><a class="struct" href="struct.Duration.html" title="struct zcash_client_backend::proto::service::Duration">Duration</a></dt><dd>Duration is currently used only for testing, so that the Ping rpc
|
|
can simulate a delay, to create many simultaneous connections. Units
|
|
are microseconds.</dd><dt><a class="struct" href="struct.Empty.html" title="struct zcash_client_backend::proto::service::Empty">Empty</a></dt><dd>Empty is for gRPCs that take no arguments, currently only GetLightdInfo.</dd><dt><a class="struct" href="struct.Exclude.html" title="struct zcash_client_backend::proto::service::Exclude">Exclude</a></dt><dt><a class="struct" href="struct.GetAddressUtxosArg.html" title="struct zcash_client_backend::proto::service::GetAddressUtxosArg">GetAddress<wbr>Utxos<wbr>Arg</a></dt><dd>Results are sorted by height, which makes it easy to issue another
|
|
request that picks up from where the previous left off.</dd><dt><a class="struct" href="struct.GetAddressUtxosReply.html" title="struct zcash_client_backend::proto::service::GetAddressUtxosReply">GetAddress<wbr>Utxos<wbr>Reply</a></dt><dt><a class="struct" href="struct.GetAddressUtxosReplyList.html" title="struct zcash_client_backend::proto::service::GetAddressUtxosReplyList">GetAddress<wbr>Utxos<wbr>Reply<wbr>List</a></dt><dt><a class="struct" href="struct.GetSubtreeRootsArg.html" title="struct zcash_client_backend::proto::service::GetSubtreeRootsArg">GetSubtree<wbr>Roots<wbr>Arg</a></dt><dt><a class="struct" href="struct.LightdInfo.html" title="struct zcash_client_backend::proto::service::LightdInfo">Lightd<wbr>Info</a></dt><dd>LightdInfo returns various information about this lightwalletd instance
|
|
and the state of the blockchain.</dd><dt><a class="struct" href="struct.PingResponse.html" title="struct zcash_client_backend::proto::service::PingResponse">Ping<wbr>Response</a></dt><dd>PingResponse is used to indicate concurrency, how many Ping rpcs
|
|
are executing upon entry and upon exit (after the delay).
|
|
This rpc is used for testing only.</dd><dt><a class="struct" href="struct.RawTransaction.html" title="struct zcash_client_backend::proto::service::RawTransaction">RawTransaction</a></dt><dd>RawTransaction contains the complete transaction data. It also optionally includes
|
|
the block height in which the transaction was included, or, when returned
|
|
by GetMempoolStream(), the latest block height.</dd><dt><a class="struct" href="struct.SendResponse.html" title="struct zcash_client_backend::proto::service::SendResponse">Send<wbr>Response</a></dt><dd>A SendResponse encodes an error code and a string. It is currently used
|
|
only by SendTransaction(). If error code is zero, the operation was
|
|
successful; if non-zero, it and the message specify the failure.</dd><dt><a class="struct" href="struct.SubtreeRoot.html" title="struct zcash_client_backend::proto::service::SubtreeRoot">Subtree<wbr>Root</a></dt><dt><a class="struct" href="struct.TransparentAddressBlockFilter.html" title="struct zcash_client_backend::proto::service::TransparentAddressBlockFilter">Transparent<wbr>Address<wbr>Block<wbr>Filter</a></dt><dd>TransparentAddressBlockFilter restricts the results to the given address
|
|
or block range.</dd><dt><a class="struct" href="struct.TreeState.html" title="struct zcash_client_backend::proto::service::TreeState">Tree<wbr>State</a></dt><dd>The TreeState is derived from the Zcash z_gettreestate rpc.</dd><dt><a class="struct" href="struct.TxFilter.html" title="struct zcash_client_backend::proto::service::TxFilter">TxFilter</a></dt><dd>A TxFilter contains the information needed to identify a particular
|
|
transaction: either a block and an index, or a direct transaction hash.
|
|
Currently, only specification by hash is supported.</dd></dl><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><dl class="item-table"><dt><a class="enum" href="enum.ShieldedProtocol.html" title="enum zcash_client_backend::proto::service::ShieldedProtocol">Shielded<wbr>Protocol</a></dt></dl></section></div></main></body></html> |