librustzcash/rustdoc/latest/zcash_client_backend/data_api/testing/index.html

2 lines
9.0 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="Utilities for testing wallets based upon the `crate::data_api` traits."><title>zcash_client_backend::data_api::testing - 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_client_backend" 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_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="#">Module testing</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><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><a href="../index.html">In zcash_<wbr>client_<wbr>backend::<wbr>data_<wbr>api</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">data_api</a></div><h1>Module <span>testing</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/data_api/testing.rs.html#1-2901">Source</a> </span></div><span class="item-info"><div class="stab portability">Available on <strong>crate feature <code>test-dependencies</code></strong> only.</div></span><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Utilities for testing wallets based upon the <a href="../index.html" title="mod zcash_client_backend::data_api"><code>crate::data_api</code></a> traits.</p>
</div></details><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><dl class="item-table"><dt><a class="mod" href="orchard/index.html" title="mod zcash_client_backend::data_api::testing::orchard">orchard</a><wbr><span class="stab portability" title="Available on crate feature `orchard` only"><code>orchard</code></span></dt><dt><a class="mod" href="pool/index.html" title="mod zcash_client_backend::data_api::testing::pool">pool</a></dt><dt><a class="mod" href="sapling/index.html" title="mod zcash_client_backend::data_api::testing::sapling">sapling</a></dt><dt><a class="mod" href="transparent/index.html" title="mod zcash_client_backend::data_api::testing::transparent">transparent</a><wbr><span class="stab portability" title="Available on crate feature `transparent-inputs` only"><code>transparent-inputs</code></span></dt></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.CachedBlock.html" title="struct zcash_client_backend::data_api::testing::CachedBlock">Cached<wbr>Block</a></dt><dd>Metadata about a block generated by <a href="struct.TestState.html" title="struct zcash_client_backend::data_api::testing::TestState"><code>TestState</code></a>.</dd><dt><a class="struct" href="struct.FakeCompactOutput.html" title="struct zcash_client_backend::data_api::testing::FakeCompactOutput">Fake<wbr>Compact<wbr>Output</a></dt><dd>A fake output of a <a href="../../proto/compact_formats/struct.CompactTx.html" title="struct zcash_client_backend::proto::compact_formats::CompactTx"><code>CompactTx</code></a>.</dd><dt><a class="struct" href="struct.InitialChainState.html" title="struct zcash_client_backend::data_api::testing::InitialChainState">Initial<wbr>Chain<wbr>State</a></dt><dd>The initial chain state for a test.</dd><dt><a class="struct" href="struct.MockWalletDb.html" title="struct zcash_client_backend::data_api::testing::MockWalletDb">Mock<wbr>Wallet<wbr>Db</a></dt><dd>A mock wallet data source that implements the bare minimum necessary to function.</dd><dt><a class="struct" href="struct.NoteCommitments.html" title="struct zcash_client_backend::data_api::testing::NoteCommitments">Note<wbr>Commitments</a></dt><dd>A convenience type for the note commitments contained within a <a href="../../proto/compact_formats/struct.CompactBlock.html" title="struct zcash_client_backend::proto::compact_formats::CompactBlock"><code>CompactBlock</code></a>.</dd><dt><a class="struct" href="struct.TestAccount.html" title="struct zcash_client_backend::data_api::testing::TestAccount">Test<wbr>Account</a></dt><dd>The test account configured for a <a href="struct.TestState.html" title="struct zcash_client_backend::data_api::testing::TestState"><code>TestState</code></a>.</dd><dt><a class="struct" href="struct.TestBuilder.html" title="struct zcash_client_backend::data_api::testing::TestBuilder">Test<wbr>Builder</a></dt><dd>A <a href="struct.TestState.html" title="struct zcash_client_backend::data_api::testing::TestState"><code>TestState</code></a> builder, that configures the environment for a test.</dd><dt><a class="struct" href="struct.TestState.html" title="struct zcash_client_backend::data_api::testing::TestState">Test<wbr>State</a></dt><dd>The state for a <code>zcash_client_backend</code> test.</dd><dt><a class="struct" href="struct.TransactionSummary.html" title="struct zcash_client_backend::data_api::testing::TransactionSummary">Transaction<wbr>Summary</a></dt><dd>Information about a transaction that the wallet is interested in.</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.AddressType.html" title="enum zcash_client_backend::data_api::testing::AddressType">Address<wbr>Type</a></dt><dd>Configures how a <a href="trait.TestFvk.html" title="trait zcash_client_backend::data_api::testing::TestFvk"><code>TestFvk</code></a> receives a particular output.</dd></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.DataStoreFactory.html" title="trait zcash_client_backend::data_api::testing::DataStoreFactory">Data<wbr>Store<wbr>Factory</a></dt><dd>Trait representing the ability to construct a new data store for use in a test.</dd><dt><a class="trait" href="trait.Reset.html" title="trait zcash_client_backend::data_api::testing::Reset">Reset</a></dt><dd>Trait method exposing the ability to reset the wallet within a test.</dd><dt><a class="trait" href="trait.TestCache.html" title="trait zcash_client_backend::data_api::testing::TestCache">Test<wbr>Cache</a></dt><dd>Trait used by tests that require a block cache.</dd><dt><a class="trait" href="trait.TestFvk.html" title="trait zcash_client_backend::data_api::testing::TestFvk">TestFvk</a></dt><dd>Trait used by tests that require a full viewing key.</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.single_output_change_strategy.html" title="fn zcash_client_backend::data_api::testing::single_output_change_strategy">single_<wbr>output_<wbr>change_<wbr>strategy</a></dt></dl></section></div></main></body></html>