Struct MessageKind 

pub struct MessageKind {
    pub version: u8,
    pub request_id: Option<u64>,
    pub trade_index: Option<i64>,
    pub id: Option<Uuid>,
    pub action: Action,
    pub payload: Option<Payload>,
}

Body shared by every Message variant.

All Mostro protocol messages share this envelope: a protocol version, an optional client-chosen request id for correlation, a trade index used to enforce strictly increasing sequences per user, an optional order/dispute id, an Action and an optional Payload.

Fields

version: u8

Mostro protocol version. Set to PROTOCOL_VER by MessageKind::new.

request_id: Option<u64>

Client-chosen correlation id, echoed back on responses so the client can match them to in-flight requests.

trade_index: Option<i64>

Trade index attached to this message. Must be strictly greater than the last trade index Mostro has seen for the sender.

id: Option<Uuid>

Optional target identifier (usually the id of an crate::order::Order or crate::dispute::Dispute).

action: Action

Verb of the message.

payload: Option<Payload>

Payload attached to the action. The allowed shape for a given action is enforced by MessageKind::verify.

Implementations

impl MessageKind

pub fn new( id: Option<Uuid>, request_id: Option<u64>, trade_index: Option<i64>, action: Action, payload: Option<Payload>, ) -> Self

Build a new MessageKind stamped with the current protocol version (PROTOCOL_VER).

pub fn from_json(json: &str) -> Result<Self, ServiceError>

Parse a MessageKind from its JSON representation.

pub fn as_json(&self) -> Result<String, ServiceError>

Serialize the MessageKind to a JSON string.

pub fn get_action(&self) -> Action

Return a clone of the Action carried by this message.

pub fn get_next_trade_key(&self) -> Result<Option<(String, u32)>, ServiceError>

Extract the (next_trade_pubkey, next_trade_index) pair from a Payload::NextTrade payload.

Returns Ok(None) when there is no payload at all and ServiceError::InvalidPayload when the payload is present but of a different variant.

pub fn get_rating(&self) -> Result<u8, ServiceError>

Extract the rating value from a Payload::RatingUser payload, validating it against MIN_RATING..=MAX_RATING.

Returns ServiceError::InvalidRating when the payload shape is wrong and ServiceError::InvalidRatingValue when the value is out of range.

pub fn verify(&self) -> bool

Check that the payload, id and trade index are consistent with the action carried by this message.

Returns true when the combination is well-formed and false otherwise; Mostro uses this method to reject malformed requests before processing them.

pub fn get_order(&self) -> Option<&SmallOrder>

Return the SmallOrder carried by a Action::NewOrder message.

Yields None if the action is not NewOrder or the payload is of a different variant.

pub fn get_payment_request(&self) -> Option<String>

Return the Lightning payment request embedded in a message.

Valid only for Action::TakeSell, Action::AddInvoice and Action::NewOrder. For NewOrder, the invoice is read from the SmallOrder::buyer_invoice field. Returns None otherwise.

pub fn get_amount(&self) -> Option<i64>

Return the amount override embedded in a Action::TakeSell or Action::TakeBuy message, either from a Payload::Amount or from the third element of a Payload::PaymentRequest.

pub fn get_payload(&self) -> Option<&Payload>

Borrow the optional payload.

pub fn has_trade_index(&self) -> (bool, i64)

Return (true, index) when the message carries a trade index, (false, 0) otherwise.

pub fn trade_index(&self) -> i64

Return the trade index carried by the message, or 0 when absent.

Trait Implementations

impl Clone for MessageKind

fn clone(&self) -> MessageKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MessageKind

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MessageKind

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for MessageKind

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

where __S: Serializer,

Serialize this value into the given Serde serializer.