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-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.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-5d1d17d0.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.86.0-nightly (99768c80a 2025-01-23)" data-channel="nightly" data-search-js="search-ccb196c1.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.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 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_<wbr>wallet</a><span class="version">1.0.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Generatable<wbr>Default<wbr>Options</a></h2><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.generate_default" title="generate_default">generate_default</a></li><li><a href="#method.generate_default_with_aux_rand" title="generate_default_with_aux_rand">generate_default_with_aux_rand</a></li><li><a href="#method.generate_with_entropy_default" title="generate_with_entropy_default">generate_with_entropy_default</a></li></ul><h3><a href="#dyn-compatibility">Dyn Compatibility</a></h3><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In bdk_<wbr>wallet::<wbr>keys</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"><span class="rustdoc-breadcrumbs"><a href="../index.html">bdk_wallet</a>::<wbr><a href="index.html">keys</a></span><h1>Trait <span class="trait">GeneratableDefaultOptions</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/bdk_wallet/keys/mod.rs.html#666-694">Source</a> </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="../descriptor/trait.ScriptContext.html" title="trait bdk_wallet::descriptor::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 <span class="item-spacer"></span> fn <a href="#method.generate_default_with_aux_rand" class="fn">generate_default_with_aux_rand</a>(
10 rng: &mut (impl <a class="trait" href="https://rust-random.github.io/rand/rand_core/trait.CryptoRng.html" title="trait rand_core::CryptoRng">CryptoRng</a> + <a class="trait" href="https://rust-random.github.io/rand/rand_core/trait.RngCore.html" title="trait rand_core::RngCore">RngCore</a>),
11 ) -> <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>> { ... }
12 }</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>
13 <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>
14 </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#672-676">Source</a><h4 class="code-header">fn <a href="#method.generate_with_entropy_default" class="fn">generate_with_entropy_default</a>(
15 entropy: Self::<a class="associatedtype" href="trait.GeneratableKey.html#associatedtype.Entropy" title="type bdk_wallet::keys::GeneratableKey::Entropy">Entropy</a>,
16 ) -> <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>
17 </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#682-684">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>
18 <p>Uses the thread-local random number generator.</p>
19 </div></details><details class="toggle method-toggle" open><summary><section id="method.generate_default_with_aux_rand" class="method"><a class="src rightside" href="../../src/bdk_wallet/keys/mod.rs.html#689-693">Source</a><h4 class="code-header">fn <a href="#method.generate_default_with_aux_rand" class="fn">generate_default_with_aux_rand</a>(
20 rng: &mut (impl <a class="trait" href="https://rust-random.github.io/rand/rand_core/trait.CryptoRng.html" title="trait rand_core::CryptoRng">CryptoRng</a> + <a class="trait" href="https://rust-random.github.io/rand/rand_core/trait.RngCore.html" title="trait rand_core::RngCore">RngCore</a>),
21 ) -> <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>
22 <p>Uses a provided random number generator (rng).</p>
23 </div></details></div><h2 id="dyn-compatibility" class="section-header">Dyn Compatibility<a href="#dyn-compatibility" class="anchor">§</a></h2><div class="dyn-compatibility-info"><p>This trait is <b>not</b> <a href="https://doc.rust-lang.org/nightly/reference/items/traits.html#dyn-compatibility">dyn compatible</a>.</p><p><i>In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.</i></p></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#698-704">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
24 Ctx: <a class="trait" href="../descriptor/trait.ScriptContext.html" title="trait bdk_wallet::descriptor::ScriptContext">ScriptContext</a>,
25 K: <a class="trait" href="trait.GeneratableKey.html" title="trait bdk_wallet::keys::GeneratableKey">GeneratableKey</a><Ctx>,
26 <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><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
27 <code>Options</code> implements <code>Default</code></p>
28 </div></section></div><script src="../../trait.impl/bdk_wallet/keys/trait.GeneratableDefaultOptions.js" async></script></section></div></main></body></html>
projects / bitcoindevkit.org / blob