Struct Cancel 

pub struct Cancel {
    pub transaction_id: String,
    pub by: String,
    pub reason: Option<String>,
}

Cancel message body (TAIP-4).

Fields

transaction_id: String

ID of the transfer being cancelled.

by: String

The party of the transaction wishing to cancel it. (In case of a Transfer [TAIP3] originator or beneficiary)

reason: Option<String>

Optional reason for cancellation.

Implementations

impl Cancel

pub fn new(transaction_id: &str, by: &str) -> Self

Create a new Cancel message

pub fn with_reason(transaction_id: &str, by: &str, reason: &str) -> Self

Create a new Cancel message with a reason

impl Cancel

pub fn validate_cancel(&self) -> Result<()>

Custom validation for Cancel messages

Trait Implementations

impl Clone for Cancel

fn clone(&self) -> Cancel

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Cancel

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Cancel

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl MessageContext for Cancel

fn participant_dids(&self) -> Vec<String>

Extract all participant DIDs from the message This replaces the old participants() method and works with Agent/Party types directly

fn transaction_context(&self) -> Option<TransactionContext>

Get transaction context if applicable

fn routing_hints(&self) -> RoutingHints

Get routing hints for message delivery

fn transaction_id(&self) -> Option<String>

Get transaction ID if available

impl Serialize for Cancel

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TapMessage for Cancel

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

Validates a TAP message.

fn is_tap_message(&self) -> bool

Checks if this message is a TAP message.

fn get_tap_type(&self) -> Option<String>

Gets the TAP message type from this message.

fn body_as<T: TapMessageBody>(&self) -> Result<T>

Extract a specific message body type from this message.

fn get_all_participants(&self) -> Vec<String>

Get all participant DIDs from this message.

fn create_reply<T: TapMessageBody>( &self, body: &T, creator_did: &str, ) -> Result<PlainMessage>

Create a reply to this message.

fn thread_id(&self) -> Option<&str>

Get the thread ID for this message

fn parent_thread_id(&self) -> Option<&str>

Get the parent thread ID for this message

fn message_id(&self) -> &str

Get the message ID for this message

impl TapMessageBody for Cancel

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_did: &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.