]> Untitled Git - bitcoindevkit.org/blob
9a185571eec59a91c8577a98cee59a26ea4e18fb
[bitcoindevkit.org] /
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"><meta name="keywords" content="rust, rustlang, rust-lang, GeneratableDefaultOptions"><title>GeneratableDefaultOptions in bdk_wallet::keys - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-1f7d512b176f0f72.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Bold-124a1ca42af929b6.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-64f7dca12162a801.css" id="mainThemeStyle"><link rel="stylesheet" id="themeStyle" href="../../static.files/light-ebce58d0a40c3431.css"><link rel="stylesheet" disabled href="../../static.files/dark-f23faae4a2daf9a6.css"><link rel="stylesheet" disabled href="../../static.files/ayu-94f39d4346842c1e.css"><script id="default-settings" ></script><script src="../../static.files/storage-d43fa987303ecbbb.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-a211dbb005fb8161.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-13285aec31fa243e.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><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">&#9776;</button><a class="sidebar-logo" href="../../bdk_wallet/index.html"><div class="logo-container"><img src="https://github.com/bitcoindevkit/bdk/raw/master/static/bdk.png" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../bdk_wallet/index.html"><div class="logo-container">
2 <img src="https://github.com/bitcoindevkit/bdk/raw/master/static/bdk.png" alt="logo"></div></a><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="#implementors">Implementors</a></h3></section><h2><a href="index.html">In bdk_wallet::keys</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-5ec35bf9ca753509.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">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" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../../src/bdk_wallet/keys/mod.rs.html#647-663">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><div class="item-decl"><pre class="rust trait"><code>pub trait GeneratableDefaultOptions&lt;Ctx&gt;: <a class="trait" href="trait.GeneratableKey.html" title="trait bdk_wallet::keys::GeneratableKey">GeneratableKey</a>&lt;Ctx&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Ctx: <a class="trait" href="trait.ScriptContext.html" title="trait bdk_wallet::keys::ScriptContext">ScriptContext</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&lt;Self as <a class="trait" href="trait.GeneratableKey.html" title="trait bdk_wallet::keys::GeneratableKey">GeneratableKey</a>&lt;Ctx&gt;&gt;::<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>,</span>{
3 fn <a href="#method.generate_with_entropy_default" class="fn">generate_with_entropy_default</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;entropy: Self::<a class="associatedtype" href="trait.GeneratableKey.html#associatedtype.Entropy" title="type bdk_wallet::keys::GeneratableKey::Entropy">Entropy</a><br>&nbsp;&nbsp;&nbsp;&nbsp;) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="struct.GeneratedKey.html" title="struct bdk_wallet::keys::GeneratedKey">GeneratedKey</a>&lt;Self, Ctx&gt;, Self::<a class="associatedtype" href="trait.GeneratableKey.html#associatedtype.Error" title="type bdk_wallet::keys::GeneratableKey::Error">Error</a>&gt; { ... }
4 <span class="item-spacer"></span> fn <a href="#method.generate_default" class="fn">generate_default</a>() -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="struct.GeneratedKey.html" title="struct bdk_wallet::keys::GeneratedKey">GeneratedKey</a>&lt;Self, Ctx&gt;, Self::<a class="associatedtype" href="trait.GeneratableKey.html#associatedtype.Error" title="type bdk_wallet::keys::GeneratableKey::Error">Error</a>&gt; { ... }
5 }</code></pre></div><details class="rustdoc-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>
6 <p>This trait is automatically implemented if the <a href="trait.GeneratableKey.html#associatedtype.Options" title="GeneratableKey::Options"><code>GeneratableKey::Options</code></a> implements <a href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html" title="Default"><code>Default</code></a>.</p>
7 </div></details><h2 id="provided-methods" class="small-section-header">Provided Methods<a href="#provided-methods" class="anchor">§</a></h2><div class="methods"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.generate_with_entropy_default" class="method has-srclink"><a class="srclink 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>(<br>&nbsp;&nbsp;&nbsp;&nbsp;entropy: Self::<a class="associatedtype" href="trait.GeneratableKey.html#associatedtype.Entropy" title="type bdk_wallet::keys::GeneratableKey::Entropy">Entropy</a><br>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="struct.GeneratedKey.html" title="struct bdk_wallet::keys::GeneratedKey">GeneratedKey</a>&lt;Self, Ctx&gt;, Self::<a class="associatedtype" href="trait.GeneratableKey.html#associatedtype.Error" title="type bdk_wallet::keys::GeneratableKey::Error">Error</a>&gt;</h4></section></summary><div class="docblock"><p>Generate a key with the default options and a given entropy</p>
8 </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.generate_default" class="method has-srclink"><a class="srclink 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>() -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="struct.GeneratedKey.html" title="struct bdk_wallet::keys::GeneratedKey">GeneratedKey</a>&lt;Self, Ctx&gt;, Self::<a class="associatedtype" href="trait.GeneratableKey.html#associatedtype.Error" title="type bdk_wallet::keys::GeneratableKey::Error">Error</a>&gt;</h4></section></summary><div class="docblock"><p>Generate a key with the default options and a random entropy</p>
9 </div></details></div><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-GeneratableDefaultOptions%3CCtx%3E-for-K" class="impl has-srclink"><a class="srclink 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&lt;Ctx, K&gt; <a class="trait" href="trait.GeneratableDefaultOptions.html" title="trait bdk_wallet::keys::GeneratableDefaultOptions">GeneratableDefaultOptions</a>&lt;Ctx&gt; for K<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Ctx: <a class="trait" href="trait.ScriptContext.html" title="trait bdk_wallet::keys::ScriptContext">ScriptContext</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;K: <a class="trait" href="trait.GeneratableKey.html" title="trait bdk_wallet::keys::GeneratableKey">GeneratableKey</a>&lt;Ctx&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;&lt;K as <a class="trait" href="trait.GeneratableKey.html" title="trait bdk_wallet::keys::GeneratableKey">GeneratableKey</a>&lt;Ctx&gt;&gt;::<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>,</span></h3></section><div class="docblock"><p>Automatic implementation of <a href="trait.GeneratableDefaultOptions.html" title="GeneratableDefaultOptions"><code>GeneratableDefaultOptions</code></a> for <a href="trait.GeneratableKey.html" title="GeneratableKey"><code>GeneratableKey</code></a>s where
10 <code>Options</code> implements <code>Default</code></p>
11 </div></div><script src="../../implementors/bdk_wallet/keys/trait.GeneratableDefaultOptions.js" async></script></section></div></main><div id="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.68.0-nightly (0f529f0f4 2022-12-13)" data-search-js="search-444266647c4dba98.js" data-settings-js="settings-bebeae96e00e4617.js" data-settings-css="settings-af96d9e2fc13e081.css" ></div></body></html>