Struct PrivateApplicationMessage 

pub struct PrivateApplicationMessage {
    pub version: Option<u8>,
    pub kind: Option<String>,
    pub app_id: Option<String>,
    pub raw_json: String,
}

One Private Application Message received from an Encrypted Link.

This is the low-level receive item for the Private Application Message stream. It keeps the raw plaintext payload so callers can route and persist messages themselves. If decrypted bytes are not UTF-8, raw_json contains a local invalid-JSON marker with the bytes encoded as base64url. Higher layers should treat that marker as malformed input, not as a Private Application Message.

Fields

version: Option<u8>

Private Application Message version from the JSON version field, when the field is present and can be represented as a u8.

kind: Option<String>

Message kind string from the JSON kind field, when the field is a string.

app_id: Option<String>

App ID string from the JSON app_id field, when the field is a string.

raw_json: String

Raw plaintext received over the Encrypted Link.

Implementations

impl PrivateApplicationMessage

pub fn known_kind(&self) -> Option<PrivateMessageKind>

Return the known Paykit kind from the raw payload, if this library can parse and recognize it.

pub fn invalid_utf8_error(&self) -> Option<&'static str>

Return a parse error for the local invalid-UTF-8 receive marker.

SDK/runtime callers use this to persist an audit/error record for a malformed stream item while still advancing the local Encrypted Link checkpoint. This is not expected on valid protocol messages.

Trait Implementations

impl Clone for PrivateApplicationMessage

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PrivateApplicationMessage

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

Formats the value using the given formatter.

impl Eq for PrivateApplicationMessage

impl PartialEq for PrivateApplicationMessage

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for PrivateApplicationMessage