Skip to main content

SendOptions

cdk_common::wallet

Struct SendOptions

pub struct SendOptions {
    pub memo: Option<SendMemo>,
    pub conditions: Option<SpendingConditions>,
    pub amount_split_target: SplitTarget,
    pub send_kind: SendKind,
    pub include_fee: bool,
    pub max_proofs: Option<usize>,
    pub metadata: HashMap<String, String>,
    pub use_p2bk: bool,
    pub p2pk_signing_keys: Vec<SecretKey>,
    pub p2pk_locked_proof_send_mode: P2PKLockedProofSendMode,
}

Expand description

Send options

Fields§

§memo: Option<SendMemo>

Memo

§conditions: Option<SpendingConditions>

Spending conditions

§amount_split_target: SplitTarget

Amount split target

§send_kind: SendKind

Send kind

§include_fee: bool

Include fee

§max_proofs: Option<usize>

Maximum number of proofs to include in the token

§metadata: HashMap<String, String>

Metadata

§use_p2bk: bool

Use P2BK (NUT-28)

§p2pk_signing_keys: Vec<SecretKey>

Signing keys for P2PK-locked input proofs; auto-detected from the wallet keyring if omitted

§p2pk_locked_proof_send_mode: P2PKLockedProofSendMode

How P2PK-locked input proofs should be handled during send

Trait Implementations§

impl Clone for SendOptions

fn clone(&self) -> Self

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

impl Debug for SendOptions

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

Formats the value using the given formatter. Read more

impl Default for SendOptions

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

impl Freeze for SendOptions

impl RefUnwindSafe for SendOptions

impl Send for SendOptions

impl Sync for SendOptions

impl Unpin for SendOptions

impl UnsafeUnpin for SendOptions

impl UnwindSafe for SendOptions

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = !

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, !>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

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

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

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

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more