1 <!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="Trait that allows generating a key with the default options"><title>GeneratableDefaultOptions in bdk_wallet::keys - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.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-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-dd39b87e5fcfba68.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="bdk_wallet" data-themes="" data-resource-suffix="" data-rustdoc-version="1.80.0-nightly (78a775127 2024-05-11)" data-channel="nightly" data-search-js="search-d52510db62a78183.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-118b08c4c78b968e.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-20a3ad099b048cf2.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-df360f571f6edeae.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.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><a class="logo-container" href="../../bdk_wallet/index.html"><img src="https://github.com/bitcoindevkit/bdk/raw/master/static/bdk.png" alt=""></a></nav><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../../bdk_wallet/index.html"><img src="https://github.com/bitcoindevkit/bdk/raw/master/static/bdk.png" alt="logo"></a><h2><a href="../../bdk_wallet/index.html">bdk_wallet</a><span class="version">1.0.0-alpha.13</span></h2></div><h2 class="location"><a href="#">GeneratableDefaultOptions</a></h2><div class="sidebar-elems"><section><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.generate_default">generate_default</a></li><li><a href="#method.generate_with_entropy_default">generate_with_entropy_default</a></li></ul><h3><a href="#object-safety">Object Safety</a></h3><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In bdk_wallet::keys</a></h2></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"><h1>Trait <a href="../index.html">bdk_wallet</a>::<wbr><a href="index.html">keys</a>::<wbr><a class="trait" href="#">GeneratableDefaultOptions</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../../src/bdk_wallet/keys/mod.rs.html#647-663">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub trait GeneratableDefaultOptions<Ctx>: <a class="trait" href="trait.GeneratableKey.html" title="trait bdk_wallet::keys::GeneratableKey">GeneratableKey</a><Ctx><div class="where">where
2 Ctx: <a class="trait" href="trait.ScriptContext.html" title="trait bdk_wallet::keys::ScriptContext">ScriptContext</a>,
3 <Self as <a class="trait" href="trait.GeneratableKey.html" title="trait bdk_wallet::keys::GeneratableKey">GeneratableKey</a><Ctx>>::<a class="associatedtype" href="trait.GeneratableKey.html#associatedtype.Options" title="type bdk_wallet::keys::GeneratableKey::Options">Options</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html" title="trait core::default::Default">Default</a>,</div>{
5 fn <a href="#method.generate_with_entropy_default" class="fn">generate_with_entropy_default</a>(
6 entropy: Self::<a class="associatedtype" href="trait.GeneratableKey.html#associatedtype.Entropy" title="type bdk_wallet::keys::GeneratableKey::Entropy">Entropy</a>
7 ) -> <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="struct.GeneratedKey.html" title="struct bdk_wallet::keys::GeneratedKey">GeneratedKey</a><Self, Ctx>, Self::<a class="associatedtype" href="trait.GeneratableKey.html#associatedtype.Error" title="type bdk_wallet::keys::GeneratableKey::Error">Error</a>> { ... }
8 <span class="item-spacer"></span> fn <a href="#method.generate_default" class="fn">generate_default</a>() -> <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="struct.GeneratedKey.html" title="struct bdk_wallet::keys::GeneratedKey">GeneratedKey</a><Self, Ctx>, Self::<a class="associatedtype" href="trait.GeneratableKey.html#associatedtype.Error" title="type bdk_wallet::keys::GeneratableKey::Error">Error</a>> { ... }
9 }</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Trait that allows generating a key with the default options</p>
10 <p>This trait is automatically implemented if the <a href="trait.GeneratableKey.html#associatedtype.Options" title="associated type bdk_wallet::keys::GeneratableKey::Options"><code>GeneratableKey::Options</code></a> implements <a href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html" title="trait core::default::Default"><code>Default</code></a>.</p>
11 </div></details><h2 id="provided-methods" class="section-header">Provided Methods<a href="#provided-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="method.generate_with_entropy_default" class="method"><a class="src rightside" href="../../src/bdk_wallet/keys/mod.rs.html#653-657">source</a><h4 class="code-header">fn <a href="#method.generate_with_entropy_default" class="fn">generate_with_entropy_default</a>(
12 entropy: Self::<a class="associatedtype" href="trait.GeneratableKey.html#associatedtype.Entropy" title="type bdk_wallet::keys::GeneratableKey::Entropy">Entropy</a>
13 ) -> <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="struct.GeneratedKey.html" title="struct bdk_wallet::keys::GeneratedKey">GeneratedKey</a><Self, Ctx>, Self::<a class="associatedtype" href="trait.GeneratableKey.html#associatedtype.Error" title="type bdk_wallet::keys::GeneratableKey::Error">Error</a>></h4></section></summary><div class="docblock"><p>Generate a key with the default options and a given entropy</p>
14 </div></details><details class="toggle method-toggle" open><summary><section id="method.generate_default" class="method"><a class="src rightside" href="../../src/bdk_wallet/keys/mod.rs.html#660-662">source</a><h4 class="code-header">fn <a href="#method.generate_default" class="fn">generate_default</a>() -> <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="struct.GeneratedKey.html" title="struct bdk_wallet::keys::GeneratedKey">GeneratedKey</a><Self, Ctx>, Self::<a class="associatedtype" href="trait.GeneratableKey.html#associatedtype.Error" title="type bdk_wallet::keys::GeneratableKey::Error">Error</a>></h4></section></summary><div class="docblock"><p>Generate a key with the default options and a random entropy</p>
15 </div></details></div><h2 id="object-safety" class="section-header">Object Safety<a href="#object-safety" class="anchor">§</a></h2><div class="object-safety-info">This trait is <b>not</b> <a href="https://doc.rust-lang.org/nightly/reference/items/traits.html#object-safety">object safe</a>.</div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-GeneratableDefaultOptions%3CCtx%3E-for-K" class="impl"><a class="src rightside" href="../../src/bdk_wallet/keys/mod.rs.html#667-673">source</a><a href="#impl-GeneratableDefaultOptions%3CCtx%3E-for-K" class="anchor">§</a><h3 class="code-header">impl<Ctx, K> <a class="trait" href="trait.GeneratableDefaultOptions.html" title="trait bdk_wallet::keys::GeneratableDefaultOptions">GeneratableDefaultOptions</a><Ctx> for K<div class="where">where
16 Ctx: <a class="trait" href="trait.ScriptContext.html" title="trait bdk_wallet::keys::ScriptContext">ScriptContext</a>,
17 K: <a class="trait" href="trait.GeneratableKey.html" title="trait bdk_wallet::keys::GeneratableKey">GeneratableKey</a><Ctx>,
18 <K as <a class="trait" href="trait.GeneratableKey.html" title="trait bdk_wallet::keys::GeneratableKey">GeneratableKey</a><Ctx>>::<a class="associatedtype" href="trait.GeneratableKey.html#associatedtype.Options" title="type bdk_wallet::keys::GeneratableKey::Options">Options</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html" title="trait core::default::Default">Default</a>,</div></h3></section><div class="docblock"><p>Automatic implementation of <a href="trait.GeneratableDefaultOptions.html" title="trait bdk_wallet::keys::GeneratableDefaultOptions"><code>GeneratableDefaultOptions</code></a> for <a href="trait.GeneratableKey.html" title="trait bdk_wallet::keys::GeneratableKey"><code>GeneratableKey</code></a>s where
19 <code>Options</code> implements <code>Default</code></p>
20 </div></div><script src="../../trait.impl/bdk_wallet/keys/trait.GeneratableDefaultOptions.js" async></script></section></div></main></body></html>
projects / bitcoindevkit.org / blob