Struct Capture 

pub struct Capture {
    pub amount: Option<String>,
    pub settlement_address: Option<String>,
    pub metadata: HashMap<String, Value>,
}

Capture message for releasing escrowed funds

The Capture message authorizes the release of escrowed funds to the beneficiary. It can only be sent by agents acting for the beneficiary.

Fields

amount: Option<String>

Amount to capture (string decimal). If omitted, captures full escrow amount. MUST be less than or equal to original amount

settlement_address: Option<String>

Blockchain address for settlement. If omitted, uses address from earlier Authorize

metadata: HashMap<String, Value>

Additional metadata

Implementations

impl Capture

pub fn new() -> Self

Create a new Capture message for the full amount

pub fn with_amount(amount: String) -> Self

Create a new Capture message for a partial amount

pub fn with_settlement_address(self, address: String) -> Self

Set the settlement address

pub fn with_metadata(self, key: String, value: Value) -> Self

Add metadata

Trait Implementations

impl Clone for Capture

fn clone(&self) -> Capture

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Capture

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

Formats the value using the given formatter.

impl Default for Capture

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Capture

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Capture

fn eq(&self, other: &Capture) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Capture

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TapMessageBody for Capture

fn message_type() -> &'static str

Get the message type string for this body type.

fn validate(&self) -> Result<()>

Validate the message body.

fn to_didcomm(&self, from: &str) -> Result<PlainMessage>

Convert this body to a DIDComm message.

fn to_didcomm_with_route<'a, I>( &self, from: &str, to: I, ) -> Result<PlainMessage>

where I: IntoIterator<Item = &'a str>,

Convert this body to a DIDComm message with a custom routing path.

fn from_didcomm(message: &PlainMessage) -> Result<Self>

where Self: Sized,

Extract this body type from a DIDComm message.

impl StructuralPartialEq for Capture