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 use_p2bk: bool,
    pub max_proofs: Option<u32>,
    pub metadata: HashMap<String, String>,
    pub p2pk_signing_keys: Vec<SecretKey>,
    pub p2pk_locked_proof_send_mode: P2PKLockedProofSendMode,
}

FFI-compatible 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

use_p2bk: bool

max_proofs: Option<u32>

Maximum number of proofs to include in the token

metadata: HashMap<String, String>

Metadata

p2pk_signing_keys: Vec<SecretKey>

Signing keys for P2PK-locked input proofs

p2pk_locked_proof_send_mode: P2PKLockedProofSendMode

How P2PK-locked input proofs should be handled during send

Implementations

impl SendOptions

pub fn to_json(&self) -> Result<String, FfiError>

Convert SendOptions to JSON string

Trait Implementations

impl Clone for SendOptions

fn clone(&self) -> SendOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<UT> ConvertError<UT> for SendOptions

fn try_convert_unexpected_callback_error( e: UnexpectedUniFFICallbackError, ) -> Result<Self>

impl Debug for SendOptions

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

Formats the value using the given formatter.

impl Default for SendOptions

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SendOptions

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<UT> FfiConverter<UT> for SendOptions

const TYPE_ID_META: MetadataBuffer

Type ID metadata, serialized into a MetadataBuffer.

type FfiType = RustBuffer

The low-level type used for passing values of this type over the FFI.

fn lower(v: Self) -> RustBuffer

Lower a rust value of the target type, into an FFI value of type Self::FfiType.

fn try_lift(buf: RustBuffer) -> Result<Self>

Lift a rust value of the target type, from an FFI value of type Self::FfiType.

fn write(obj: Self, buf: &mut Vec<u8>)

Write a rust value into a buffer, to send over the FFI in serialized form.

fn try_read(buf: &mut &[u8]) -> Result<Self>

Read a rust value from a buffer, received over the FFI in serialized form.

impl From<SendOptions> for SendOptions

fn from(opts: SendOptions) -> Self

Converts to this type from the input type.

impl<UT> Lift<UT> for SendOptions

type FfiType = <SendOptions as FfiConverter<UT>>::FfiType

fn try_lift(v: Self::FfiType) -> Result<Self>

fn try_read(buf: &mut &[u8]) -> Result<Self>

fn try_lift_from_rust_buffer(v: RustBuffer) -> Result<Self, Error>

Convenience method

impl<UT> LiftRef<UT> for SendOptions

type LiftType = SendOptions

impl<UT> LiftReturn<UT> for SendOptions

type ReturnType = <SendOptions as Lift<UT>>::FfiType

FFI return type for trait interfaces

fn try_lift_successful_return(v: Self::ReturnType) -> Result<Self>

Lift a successfully returned value from a trait interface

fn lift_foreign_return( ffi_return: Self::ReturnType, call_status: RustCallStatus, ) -> Self

Lift a foreign returned value from a trait interface

fn lift_error(_buf: RustBuffer) -> Self

Lift a Rust value for a callback interface method error result

fn handle_callback_unexpected_error(e: UnexpectedUniFFICallbackError) -> Self

Lift a Rust value for an unexpected callback interface error

impl<UT> Lower<UT> for SendOptions

type FfiType = <SendOptions as FfiConverter<UT>>::FfiType

fn lower(obj: Self) -> Self::FfiType

fn write(obj: Self, buf: &mut Vec<u8>)

fn lower_into_rust_buffer(obj: Self) -> RustBuffer

Convenience method

impl<UT> LowerError<UT> for SendOptions

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for SendOptions

type ReturnType = <SendOptions as Lower<UT>>::FfiType

The type that should be returned by scaffolding functions for this type.

fn lower_return(v: Self) -> Result<Self::ReturnType, RustCallError>

Lower the return value from an scaffolding call

fn handle_failed_lift( error: LiftArgsError, ) -> Result<Self::ReturnType, RustCallError>

Lower the return value for failed argument lifts

impl Serialize for SendOptions

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<SendOptions> for SendOptions

type Error = FfiError

The type returned in the event of a conversion error.

fn try_from(opts: SendOptions) -> Result<Self, Self::Error>

Performs the conversion.

impl<UT> TypeId<UT> for SendOptions

const TYPE_ID_META: MetadataBuffer