From: github-actions Date: Fri, 26 Feb 2021 09:13:31 +0000 (+0000) Subject: Publish autogenerated nightly docs X-Git-Url: http://internal-gitweb-vhost/script/%22https:/struct.EncoderStringWriter.html?a=commitdiff_plain;h=765b89106007cc184aabe2fdfd3918fa9a4888a2;p=bitcoindevkit.org Publish autogenerated nightly docs --- diff --git a/static/docs-rs/bdk/nightly/latest/bdk/all.html b/static/docs-rs/bdk/nightly/latest/bdk/all.html index d3beefed2b..0906e9a68a 100644 --- a/static/docs-rs/bdk/nightly/latest/bdk/all.html +++ b/static/docs-rs/bdk/nightly/latest/bdk/all.html @@ -3,5 +3,5 @@

List of all items[] - List of all items

Structs

Enums

Traits

Macros

Functions

Typedefs

+ List of all items

Structs

Enums

Traits

Macros

Functions

Typedefs

\ No newline at end of file diff --git a/static/docs-rs/bdk/nightly/latest/bdk/database/any/enum.AnyBatch.html b/static/docs-rs/bdk/nightly/latest/bdk/database/any/enum.AnyBatch.html index ce80781f5b..557e147983 100644 --- a/static/docs-rs/bdk/nightly/latest/bdk/database/any/enum.AnyBatch.html +++ b/static/docs-rs/bdk/nightly/latest/bdk/database/any/enum.AnyBatch.html @@ -10,14 +10,14 @@
Memory(<MemoryDatabase as BatchDatabase>::Batch)

In-memory ephemeral database

Sled(<Tree as BatchDatabase>::Batch)
This is supported on crate feature key-value-db only.

Simple key-value embedded database based on [sled]

Trait Implementations

impl BatchOperations for AnyBatch[src]

impl BatchOperations for AnyDatabase[src]

impl Database for AnyDatabase[src]

impl BatchOperations for MemoryDatabase[src]

impl Database for MemoryDatabase[src]

Loading content...

Implementations on Foreign Types

impl BatchOperations for Tree[src]

impl BatchOperations for Batch[src]

Loading content...

Implementors

impl BatchOperations for AnyBatch[src]

impl BatchOperations for AnyDatabase[src]

impl BatchOperations for MemoryDatabase[src]

Loading content...
\ No newline at end of file diff --git a/static/docs-rs/bdk/nightly/latest/bdk/database/trait.Database.html b/static/docs-rs/bdk/nightly/latest/bdk/database/trait.Database.html index a3d1d00c1d..e2362e6351 100644 --- a/static/docs-rs/bdk/nightly/latest/bdk/database/trait.Database.html +++ b/static/docs-rs/bdk/nightly/latest/bdk/database/trait.Database.html @@ -4,12 +4,12 @@ Change settings

Trait bdk::database::Database[][src]

pub trait Database: BatchOperations {
     fn check_descriptor_checksum<B: AsRef<[u8]>>(
        &mut self,
        keychain: KeychainKind,
        bytes: B
    ) -> Result<(), Error>;
fn iter_script_pubkeys(
        &self,
        keychain: Option<KeychainKind>
    ) -> Result<Vec<Script>, Error>; -
fn iter_utxos(&self) -> Result<Vec<UTXO>, Error>; +
fn iter_utxos(&self) -> Result<Vec<LocalUtxo>, Error>;
fn iter_raw_txs(&self) -> Result<Vec<Transaction>, Error>;
fn iter_txs(
        &self,
        include_raw: bool
    ) -> Result<Vec<TransactionDetails>, Error>;
fn get_script_pubkey_from_path(
        &self,
        keychain: KeychainKind,
        child: u32
    ) -> Result<Option<Script>, Error>;
fn get_path_from_script_pubkey(
        &self,
        script: &Script
    ) -> Result<Option<(KeychainKind, u32)>, Error>; -
fn get_utxo(&self, outpoint: &OutPoint) -> Result<Option<UTXO>, Error>; +
fn get_utxo(&self, outpoint: &OutPoint) -> Result<Option<LocalUtxo>, Error>;
fn get_raw_tx(&self, txid: &Txid) -> Result<Option<Transaction>, Error>;
fn get_tx(
        &self,
        txid: &Txid,
        include_raw: bool
    ) -> Result<Option<TransactionDetails>, Error>;
fn get_last_index(
        &self,
        keychain: KeychainKind
    ) -> Result<Option<u32>, Error>; @@ -21,16 +21,16 @@ checksum doesn’t match. If there’s no checksum in the database, simply store it for the next time.

fn iter_script_pubkeys(
    &self,
    keychain: Option<KeychainKind>
) -> Result<Vec<Script>, Error>
[src]

Return the list of script_pubkeys

-

fn iter_utxos(&self) -> Result<Vec<UTXO>, Error>[src]

Return the list of UTXOs

+

fn iter_utxos(&self) -> Result<Vec<LocalUtxo>, Error>[src]

Return the list of LocalUtxos

fn iter_raw_txs(&self) -> Result<Vec<Transaction>, Error>[src]

Return the list of raw transactions

fn iter_txs(&self, include_raw: bool) -> Result<Vec<TransactionDetails>, Error>[src]

Return the list of transactions metadata

fn get_script_pubkey_from_path(
    &self,
    keychain: KeychainKind,
    child: u32
) -> Result<Option<Script>, Error>
[src]

Fetch a script_pubkey given the child number of a keychain.

fn get_path_from_script_pubkey(
    &self,
    script: &Script
) -> Result<Option<(KeychainKind, u32)>, Error>
[src]

Fetch the keychain and child number of a given script_pubkey

-

fn get_utxo(&self, outpoint: &OutPoint) -> Result<Option<UTXO>, Error>[src]

Fetch a UTXO given its [OutPoint]

+

fn get_utxo(&self, outpoint: &OutPoint) -> Result<Option<LocalUtxo>, Error>[src]

Fetch a LocalUtxo given its [OutPoint]

fn get_raw_tx(&self, txid: &Txid) -> Result<Option<Transaction>, Error>[src]

Fetch a raw transaction given its [Txid]

fn get_tx(
    &self,
    txid: &Txid,
    include_raw: bool
) -> Result<Option<TransactionDetails>, Error>
[src]

Fetch the transaction metadata and optionally also the raw transaction

fn get_last_index(&self, keychain: KeychainKind) -> Result<Option<u32>, Error>[src]

Return the last defivation index for a keychain.

fn increment_last_index(&mut self, keychain: KeychainKind) -> Result<u32, Error>[src]

Increment the last derivation index for a keychain and return it

It should insert and return 0 if not present in the database

-
Loading content...

Implementations on Foreign Types

impl Database for Tree[src]

Loading content...

Implementors

impl Database for AnyDatabase[src]

impl Database for MemoryDatabase[src]

Loading content...
+
Loading content...

Implementations on Foreign Types

impl Database for Tree[src]

Loading content...

Implementors

impl Database for AnyDatabase[src]

impl Database for MemoryDatabase[src]

Loading content...
\ No newline at end of file diff --git a/static/docs-rs/bdk/nightly/latest/bdk/enum.Utxo.html b/static/docs-rs/bdk/nightly/latest/bdk/enum.Utxo.html new file mode 100644 index 0000000000..1ca155551d --- /dev/null +++ b/static/docs-rs/bdk/nightly/latest/bdk/enum.Utxo.html @@ -0,0 +1,54 @@ +bdk::Utxo - Rust + +

Enum bdk::Utxo[][src]

pub enum Utxo {
+    Local(LocalUtxo),
+    Foreign {
+        outpoint: OutPoint,
+        psbt_input: Box<Input>,
+    },
+}

An unspent transaction output (UTXO).

+

+ Variants

+
Local(LocalUtxo)

A UTXO owned by the local wallet.

+
Foreign

A UTXO owned by another wallet.

+

Fields of Foreign

outpoint: OutPoint

The location of the output.

+
psbt_input: Box<Input>

The information about the input we require to add it to a PSBT.

+

Implementations

impl Utxo[src]

pub fn outpoint(&self) -> OutPoint[src]

Get the location of the UTXO

+

pub fn txout(&self) -> &TxOut[src]

Get the TxOut of the UTXO

+

Trait Implementations

impl Clone for Utxo[src]

impl Debug for Utxo[src]

impl PartialEq<Utxo> for Utxo[src]

impl StructuralPartialEq for Utxo[src]

Auto Trait Implementations

impl RefUnwindSafe for Utxo

impl Send for Utxo

impl Sync for Utxo

impl Unpin for Utxo

impl UnwindSafe for Utxo

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T> Instrument for T[src]

impl<T> Instrument for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> Pointable for T

type Init = T

The type for initializers.

+

impl<T> Same<T> for T

type Output = T

Should always be Self

+

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

+

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

+

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

+

impl<V, T> VZip<V> for T where
    V: MultiLane<T>, 

+ \ No newline at end of file diff --git a/static/docs-rs/bdk/nightly/latest/bdk/index.html b/static/docs-rs/bdk/nightly/latest/bdk/index.html index fb90f9193c..01912d8cec 100644 --- a/static/docs-rs/bdk/nightly/latest/bdk/index.html +++ b/static/docs-rs/bdk/nightly/latest/bdk/index.html @@ -158,11 +158,13 @@ BDK.

fragment

Macro to write descriptor fragments with code

Structs

FeeRate

Fee rate

+
LocalUtxo

An unspent output owned by a Wallet.

TransactionDetails

A wallet transaction

-
UTXO

A wallet unspent output

+
WeightedUtxo

A Utxo with its satisfaction_weight.

Enums

Error

Errors that can be thrown by the Wallet

KeychainKind

Types of keychains

+
Utxo

An unspent transaction output (UTXO).

Functions

version

Get the version of BDK at runtime

diff --git a/static/docs-rs/bdk/nightly/latest/bdk/sidebar-items.js b/static/docs-rs/bdk/nightly/latest/bdk/sidebar-items.js index 238bcc8217..8f3be7090c 100644 --- a/static/docs-rs/bdk/nightly/latest/bdk/sidebar-items.js +++ b/static/docs-rs/bdk/nightly/latest/bdk/sidebar-items.js @@ -1 +1 @@ -initSidebarItems({"enum":[["Error","Errors that can be thrown by the `Wallet`"],["KeychainKind","Types of keychains"]],"fn":[["version","Get the version of BDK at runtime"]],"macro":[["descriptor","Macro to write full descriptors with code"],["fragment","Macro to write descriptor fragments with code"]],"mod":[["blockchain","Blockchain backends"],["database","Database types"],["descriptor","Descriptors"],["keys","Key formats"],["wallet","Wallet"]],"struct":[["FeeRate","Fee rate"],["TransactionDetails","A wallet transaction"],["UTXO","A wallet unspent output"]]}); \ No newline at end of file +initSidebarItems({"enum":[["Error","Errors that can be thrown by the `Wallet`"],["KeychainKind","Types of keychains"],["Utxo","An unspent transaction output (UTXO)."]],"fn":[["version","Get the version of BDK at runtime"]],"macro":[["descriptor","Macro to write full descriptors with code"],["fragment","Macro to write descriptor fragments with code"]],"mod":[["blockchain","Blockchain backends"],["database","Database types"],["descriptor","Descriptors"],["keys","Key formats"],["wallet","Wallet"]],"struct":[["FeeRate","Fee rate"],["LocalUtxo","An unspent output owned by a `Wallet`."],["TransactionDetails","A wallet transaction"],["WeightedUtxo","A [`Utxo`] with its `satisfaction_weight`."]]}); \ No newline at end of file diff --git a/static/docs-rs/bdk/nightly/latest/bdk/struct.LocalUtxo.html b/static/docs-rs/bdk/nightly/latest/bdk/struct.LocalUtxo.html new file mode 100644 index 0000000000..d32b59811f --- /dev/null +++ b/static/docs-rs/bdk/nightly/latest/bdk/struct.LocalUtxo.html @@ -0,0 +1,51 @@ +bdk::LocalUtxo - Rust + +

Struct bdk::LocalUtxo[][src]

pub struct LocalUtxo {
+    pub outpoint: OutPoint,
+    pub txout: TxOut,
+    pub keychain: KeychainKind,
+}

An unspent output owned by a Wallet.

+

+ Fields

outpoint: OutPoint

Reference to a transaction output

+
txout: TxOut

Transaction output

+
keychain: KeychainKind

Type of keychain

+

Trait Implementations

impl Clone for LocalUtxo[src]

impl Debug for LocalUtxo[src]

impl<'de> Deserialize<'de> for LocalUtxo[src]

impl Eq for LocalUtxo[src]

impl PartialEq<LocalUtxo> for LocalUtxo[src]

impl Serialize for LocalUtxo[src]

impl StructuralEq for LocalUtxo[src]

impl StructuralPartialEq for LocalUtxo[src]

Auto Trait Implementations

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> DeserializeOwned for T where
    T: for<'de> Deserialize<'de>, 
[src]

impl<Q, K> Equivalent<K> for Q where
    Q: Eq + ?Sized,
    K: Borrow<Q> + ?Sized
[src]

impl<T> From<T> for T[src]

impl<T> Instrument for T[src]

impl<T> Instrument for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> Pointable for T

type Init = T

The type for initializers.

+

impl<T> Same<T> for T

type Output = T

Should always be Self

+

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

+

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

+

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

+

impl<V, T> VZip<V> for T where
    V: MultiLane<T>, 

+ \ No newline at end of file diff --git a/static/docs-rs/bdk/nightly/latest/bdk/struct.TransactionDetails.html b/static/docs-rs/bdk/nightly/latest/bdk/struct.TransactionDetails.html index ea265d0d1a..3277007623 100644 --- a/static/docs-rs/bdk/nightly/latest/bdk/struct.TransactionDetails.html +++ b/static/docs-rs/bdk/nightly/latest/bdk/struct.TransactionDetails.html @@ -1,7 +1,7 @@ bdk::TransactionDetails - Rust

Struct bdk::TransactionDetails[][src]

pub struct TransactionDetails {
+                Change settings

Struct bdk::TransactionDetails[][src]

pub struct TransactionDetails {
     pub transaction: Option<Transaction>,
     pub txid: Txid,
     pub timestamp: u64,
@@ -18,16 +18,16 @@
 
sent: u64

Sent value (sats)

fees: u64

Fee value (sats)

height: Option<u32>

Confirmed in block height, None means unconfirmed

-

Trait Implementations

impl Clone for TransactionDetails[src]

Trait Implementations

impl Clone for TransactionDetails[src]

impl Debug for TransactionDetails[src]

impl Default for TransactionDetails[src]

impl<'de> Deserialize<'de> for TransactionDetails[src]

impl Eq for TransactionDetails[src]

impl PartialEq<TransactionDetails> for TransactionDetails[src]

impl Debug for TransactionDetails[src]

impl Default for TransactionDetails[src]

impl<'de> Deserialize<'de> for TransactionDetails[src]

impl Eq for TransactionDetails[src]

impl PartialEq<TransactionDetails> for TransactionDetails[src]

impl Serialize for TransactionDetails[src]

impl StructuralEq for TransactionDetails[src]

impl StructuralPartialEq for TransactionDetails[src]

Auto Trait Implementations

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl Serialize for TransactionDetails[src]

impl StructuralEq for TransactionDetails[src]

impl StructuralPartialEq for TransactionDetails[src]

Auto Trait Implementations

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> DeserializeOwned for T where
    T: for<'de> Deserialize<'de>, 
[src]

impl<Q, K> Equivalent<K> for Q where
    Q: Eq + ?Sized,
    K: Borrow<Q> + ?Sized
[src]