From: github-actions Date: Tue, 21 Jan 2025 22:59:10 +0000 (+0000) Subject: Publish autogenerated nightly docs X-Git-Url: http://internal-gitweb-vhost/?a=commitdiff_plain;h=acb7469321bf2e7d9c064a30c2fa4ffa2ab31c91;p=bitcoindevkit.org Publish autogenerated nightly docs --- diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/enum.FileStoreError.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/enum.FileStoreError.html index f184ea7fe9..861391c841 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/enum.FileStoreError.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/enum.FileStoreError.html @@ -1,8 +1,8 @@ FileStoreError in bdk_wallet - Rust
bdk_wallet

Enum FileStoreError

Source 
pub enum FileStoreError {
-    Load(AggregateChangesetsError<ChangeSet>),
+    Load(AggregateChangesetsError<ChangeSet>),
     Write(Error),
-}
Expand description

Error for bdk_file_store’s implementation of WalletPersister.

-

Variants§

§

Load(AggregateChangesetsError<ChangeSet>)

Error when loading from the store.

+}
Expand description

Error for [bdk_file_store]’s implementation of WalletPersister.

+

Variants§

§

Load(AggregateChangesetsError<ChangeSet>)

Error when loading from the store.

§

Write(Error)

Error when writing to the store.

Trait Implementations§

Source§

impl Debug for FileStoreError

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Display for FileStoreError

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Error for FileStoreError

1.30.0 · Source§

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()
Read more
1.0.0 · Source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
Source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type-based access to context intended for error reports. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/index.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/index.html index f7f993d395..0ca5c72a41 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/index.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/index.html @@ -182,7 +182,7 @@ that the Wallet can use to update its view of the chain.

submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

-

Re-exports§

pub extern crate bitcoin;
pub extern crate bdk_chain as chain;
pub extern crate bdk_file_store as file_store;
pub extern crate miniscript;
pub extern crate serde;
pub extern crate serde_json;
pub use descriptor::template;
pub use descriptor::HdKeyPaths;
pub use signer;
pub use bdk_chain::rusqlite;

Modules§

coin_selection
Coin selection
descriptor
Descriptors
error
Errors that can be thrown by the Wallet
export
Wallet export
keys
Key formats
psbt
Additional functions on the rust-bitcoin Psbt structure.
rusqlite_impl
Support for persisting bdk_chain structures to SQLite using [rusqlite].
signer
Generalized signers
tx_builder
Transaction builder

Macros§

descriptor
Macro to write full descriptors with code
fragment
Macro to write descriptor fragments with code

Structs§

AddressInfo
A derived address and the index it was found at. -For convenience this automatically derefs to Address
Balance
Balance, differentiated into various categories.
ChangeSet
A changeset for Wallet.
CreateParams
Parameters for Wallet::create or PersistedWallet::create.
LoadParams
Parameters for Wallet::load or PersistedWallet::load.
LocalOutput
An unspent output owned by a Wallet.
PersistedWallet
Represents a persisted wallet which persists into type P.
SignOptions
Options for a software signer
TxBuilder
A transaction builder
Update
An update to Wallet.
Wallet
A Bitcoin wallet
WeightedUtxo
A Utxo with its satisfaction_weight.

Enums§

AddForeignUtxoError
Error returned from TxBuilder::add_foreign_utxo.
AddUtxoError
Error returned from TxBuilder::add_utxo and TxBuilder::add_utxos
ApplyBlockError
An error that may occur when applying a block to Wallet.
ChangeSpendPolicy
Policy regarding the use of change outputs when creating a transaction
CreateWithPersistError
Error type for PersistedWallet::create.
FileStoreError
Error for bdk_file_store’s implementation of WalletPersister.
KeychainKind
Types of keychains
LoadError
The error type when loading a Wallet from a ChangeSet.
LoadMismatch
Represents a mismatch with what is loaded and what is expected from LoadParams.
LoadWithPersistError
Error type for PersistedWallet::load.
TxOrdering
Ordering of the transaction’s inputs and outputs
Utxo
An unspent transaction output (UTXO).

Traits§

AsyncWalletPersister
Async trait that persists PersistedWallet.
IsDust
Trait to check if a value is below the dust limit. +

Re-exports§

pub extern crate bitcoin;
pub extern crate bdk_chain as chain;
pub extern crate bdk_file_store as file_store;
pub extern crate miniscript;
pub extern crate serde;
pub extern crate serde_json;
pub use descriptor::template;
pub use descriptor::HdKeyPaths;
pub use signer;
pub use bdk_chain::rusqlite;

Modules§

coin_selection
Coin selection
descriptor
Descriptors
error
Errors that can be thrown by the Wallet
export
Wallet export
keys
Key formats
psbt
Additional functions on the rust-bitcoin Psbt structure.
rusqlite_impl
Support for persisting bdk_chain structures to SQLite using [rusqlite].
signer
Generalized signers
tx_builder
Transaction builder

Macros§

descriptor
Macro to write full descriptors with code
fragment
Macro to write descriptor fragments with code

Structs§

AddressInfo
A derived address and the index it was found at. +For convenience this automatically derefs to Address
Balance
Balance, differentiated into various categories.
ChangeSet
A changeset for Wallet.
CreateParams
Parameters for Wallet::create or PersistedWallet::create.
LoadParams
Parameters for Wallet::load or PersistedWallet::load.
LocalOutput
An unspent output owned by a Wallet.
PersistedWallet
Represents a persisted wallet which persists into type P.
SignOptions
Options for a software signer
TxBuilder
A transaction builder
Update
An update to Wallet.
Wallet
A Bitcoin wallet
WeightedUtxo
A Utxo with its satisfaction_weight.

Enums§

AddForeignUtxoError
Error returned from TxBuilder::add_foreign_utxo.
AddUtxoError
Error returned from TxBuilder::add_utxo and TxBuilder::add_utxos
ApplyBlockError
An error that may occur when applying a block to Wallet.
ChangeSpendPolicy
Policy regarding the use of change outputs when creating a transaction
CreateWithPersistError
Error type for PersistedWallet::create.
FileStoreError
Error for [bdk_file_store]’s implementation of WalletPersister.
KeychainKind
Types of keychains
LoadError
The error type when loading a Wallet from a ChangeSet.
LoadMismatch
Represents a mismatch with what is loaded and what is expected from LoadParams.
LoadWithPersistError
Error type for PersistedWallet::load.
TxOrdering
Ordering of the transaction’s inputs and outputs
Utxo
An unspent transaction output (UTXO).

Traits§

AsyncWalletPersister
Async trait that persists PersistedWallet.
IsDust
Trait to check if a value is below the dust limit. We are performing dust value calculation for a given script public key using rust-bitcoin to keep it compatible with network dust rate
WalletPersister
Trait that persists PersistedWallet.

Functions§

version
Get the version of bdk_wallet at runtime.
wallet_name_from_descriptor
Deterministically generate a unique name given the descriptors defining the wallet

Type Aliases§

WalletTx
A CanonicalTx managed by a Wallet.
\ No newline at end of file diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/trait.WalletPersister.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/trait.WalletPersister.html index 023fbb8881..c017d440de 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/trait.WalletPersister.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/trait.WalletPersister.html @@ -30,10 +30,10 @@ persister implementations may NOT require initialization at all (and not error). changeset: &ChangeSet, ) -> Result<(), Self::Error>

Persist the given changeset to the persister.

This method can fail if the persister is not initialized.

-

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types§

Source§

impl WalletPersister for Store<ChangeSet>

Source§

type Error = FileStoreError

Source§

fn initialize(persister: &mut Self) -> Result<ChangeSet, Self::Error>

Source§

fn persist( +

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types§

Source§

impl WalletPersister for Connection

Source§

type Error = Error

Source§

fn initialize(persister: &mut Self) -> Result<ChangeSet, Self::Error>

Source§

fn persist( persister: &mut Self, changeset: &ChangeSet, -) -> Result<(), Self::Error>

Source§

impl WalletPersister for Connection

Source§

type Error = Error

Source§

fn initialize(persister: &mut Self) -> Result<ChangeSet, Self::Error>

Source§

fn persist( +) -> Result<(), Self::Error>

Source§

impl WalletPersister for Store<ChangeSet>

Source§

type Error = FileStoreError

Source§

fn initialize(persister: &mut Self) -> Result<ChangeSet, Self::Error>

Source§

fn persist( persister: &mut Self, changeset: &ChangeSet, ) -> Result<(), Self::Error>

Source§

impl WalletPersister for Transaction<'_>

Source§

type Error = Error

Source§

fn initialize(persister: &mut Self) -> Result<ChangeSet, Self::Error>

Source§

fn persist( diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_cli/fn.handle_commands.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_cli/fn.handle_commands.html index 9e518debec..50eee1eb5a 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_cli/fn.handle_commands.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_cli/fn.handle_commands.html @@ -1,7 +1,7 @@ handle_commands in example_cli - Rust
example_cli

Function handle_commands

Source 
pub fn handle_commands<CS: Subcommand, S: Args>(
     graph: &Mutex<KeychainTxGraph>,
     chain: &Mutex<LocalChain>,
-    db: &Mutex<Store<ChangeSet>>,
+    db: &Mutex<Store<ChangeSet>>,
     network: Network,
     broadcast: impl FnOnce(S, &Transaction) -> Result<()>,
     cmd: Commands<CS, S>,
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_cli/struct.Init.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_cli/struct.Init.html
index 8acaaaa59c..086bc2c30e 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_cli/struct.Init.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/example_cli/struct.Init.html
@@ -2,13 +2,13 @@
     pub args: Args<CS, S>,
     pub graph: Mutex<KeychainTxGraph>,
     pub chain: Mutex<LocalChain>,
-    pub db: Mutex<Store<ChangeSet>>,
+    pub db: Mutex<Store<ChangeSet>>,
     pub network: Network,
 }
Expand description

The initial state returned by init_or_load.

Fields§

§args: Args<CS, S>

CLI args

§graph: Mutex<KeychainTxGraph>

Indexed graph

§chain: Mutex<LocalChain>

Local chain

-
§db: Mutex<Store<ChangeSet>>

Database

+
§db: Mutex<Store<ChangeSet>>

Database

§network: Network

Network

Auto Trait Implementations§

§

impl<CS, S> !Freeze for Init<CS, S>

§

impl<CS, S> RefUnwindSafe for Init<CS, S>
where CS: RefUnwindSafe,