Struct PlainMessage

pub struct PlainMessage {

    pub id: String,
    pub typ: String,
    pub type_: String,
    pub body: Value,
    pub from: String,
    pub to: Vec<String>,
    pub thid: Option<String>,
    pub pthid: Option<String>,
    pub extra_headers: HashMap<String, Value>,
    pub created_time: Option<u64>,
    pub expires_time: Option<u64>,
    pub from_prior: Option<String>,
    pub attachments: Option<Vec<Attachment>>,
}

Wrapper for plain message. Provides helpers for message building and packing/unpacking. Adapted from https://github.com/sicpa-dlab/didcomm-rust/blob/main/src/message/message.rs

Fields

id: String

Message id. Must be unique to the sender.

typ: String

Optional, if present it must be “application/didcomm-plain+json”

type_: String

Message type attribute value MUST be a valid Message Type URI, that when resolved gives human readable information about the message. The attribute’s value also informs the content of the message, or example the presence of other attributes and how they should be processed.

body: Value

Message body.

from: String

Sender identifier. The from attribute MUST be a string that is a valid DID or DID URL (without the fragment component) which identifies the sender of the message.

to: Vec<String>

Identifier(s) for recipients. MUST be an array of strings where each element is a valid DID or DID URL (without the fragment component) that identifies a member of the message’s intended audience.

thid: Option<String>

Uniquely identifies the thread that the message belongs to. If not included the id property of the message MUST be treated as the value of the thid.

pthid: Option<String>

If the message is a child of a thread the pthid will uniquely identify which thread is the parent.

extra_headers: HashMap<String, Value>

Custom message headers.

created_time: Option<u64>

The attribute is used for the sender to express when they created the message, expressed in UTC Epoch Seconds (seconds since 1970-01-01T00:00:00Z UTC). This attribute is informative to the recipient, and may be relied on by protocols.

expires_time: Option<u64>

The expires_time attribute is used for the sender to express when they consider the message to be expired, expressed in UTC Epoch Seconds (seconds since 1970-01-01T00:00:00Z UTC). This attribute signals when the message is considered no longer valid by the sender. When omitted, the message is considered to have no expiration by the sender.

from_prior: Option<String>

from_prior is a compactly serialized signed JWT containing FromPrior value

attachments: Option<Vec<Attachment>>

Trait Implementations

impl Clone for PlainMessage

fn clone(&self) -> PlainMessage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Connectable for PlainMessage

fn with_connection(&mut self, connect_id: &str) -> &mut PlainMessage

Connect this message to a prior Connect message by setting the parent thread ID (pthid).

fn has_connection(&self) -> bool

Check if this message is connected to a prior Connect message.

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

Get the connection ID if present.

impl Debug for PlainMessage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PlainMessage

fn deserialize<__D>( __deserializer: __D, ) -> Result<PlainMessage, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Packable for PlainMessage

Implement Packable for PlainMessage

fn pack<'life0, 'life1, 'async_trait>( &'life0 self, key_manager: &'life1 (impl 'async_trait + KeyManagerPacking + ?Sized), options: PackOptions, ) -> Pin<Box<dyn Future<Output = Result<String>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Pack the object for secure transmission

impl PartialEq for PlainMessage

fn eq(&self, other: &PlainMessage) -> 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 PlainMessage

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TapMessage for PlainMessage

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

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>(&self) -> Result<T, Error>

where T: TapMessageBody,

Extract a specific message body type from this message.

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

Get all participant DIDs from this message.

fn message_type(&self) -> &'static str

Get the message type for 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

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

where T: TapMessageBody,

Create a reply to this message.

impl Eq for PlainMessage

impl StructuralPartialEq for PlainMessage