Enum ToServer

pub enum ToServer {
    Send {
        destination: String,
        transaction: Option<String>,
        headers: Option<Vec<(String, String)>>,
        body: Option<Vec<u8>>,
    },
    Subscribe {
        destination: String,
        id: String,
        ack: Option<AckMode>,
    },
    Unsubscribe {
        id: String,
    },
    Ack {
        id: String,
        transaction: Option<String>,
    },
    Nack {
        id: String,
        transaction: Option<String>,
    },
    Begin {
        transaction: String,
    },
    Commit {
        transaction: String,
    },
    Abort {
        transaction: String,
    },
    Disconnect {
        receipt: Option<String>,
    },
    // some variants omitted
}

A STOMP message sent by the client

This enum represents all possible message types that can be sent to a STOMP server according to the STOMP 1.2 specification.

See the STOMP 1.2 Specification for more detailed information about each message type.

Variants

Send

Send a message to a destination in the messaging system

Used to send a message to a specific destination like a queue or topic.

Fields

destination: String

Destination to send the message to

transaction: Option<String>

Optional transaction identifier

headers: Option<Vec<(String, String)>>

Optional additional headers to include

body: Option<Vec<u8>>

Optional message body

Subscribe

Register to listen to a given destination

Creates a subscription to receive messages from a specific destination.

Fields

destination: String

Destination to subscribe to

id: String

Client-generated subscription identifier

ack: Option<AckMode>

Optional acknowledgment mode

Unsubscribe

Remove an existing subscription

Cancels a subscription so the client stops receiving messages from it.

Fields

id: String

Subscription identifier to unsubscribe from

Ack

Acknowledge consumption of a message from a subscription

Used with ‘client’ or ‘client-individual’ acknowledgment modes to confirm successful processing of a message.

Fields

id: String

Message or subscription identifier to acknowledge

transaction: Option<String>

Optional transaction identifier

Nack

Notify the server that the client did not consume the message

Used with ‘client’ or ‘client-individual’ acknowledgment modes to indicate that a message could not be processed successfully.

Fields

id: String

Message or subscription identifier to negative-acknowledge

transaction: Option<String>

Optional transaction identifier

Begin

Start a transaction

Begins a new transaction that can group multiple STOMP operations.

Fields

transaction: String

Client-generated transaction identifier

Commit

Commit an in-progress transaction

Completes a transaction and applies all its operations.

Fields

transaction: String

Transaction identifier to commit

Abort

Roll back an in-progress transaction

Cancels a transaction and rolls back all its operations.

Fields

transaction: String

Transaction identifier to abort

Disconnect

Gracefully disconnect from the server

Cleanly ends the STOMP session. Clients MUST NOT send any more frames after the DISCONNECT frame is sent.

Fields

receipt: Option<String>

Optional receipt request

Trait Implementations

impl Clone for ToServer

fn clone(&self) -> ToServer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ToServer

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

Formats the value using the given formatter.

impl From<ToServer> for Message<ToServer>

Implement From for Message to allow easy conversion

This allows ToServer enum variants to be easily converted to a Message with empty extra_headers, which is a common need when sending messages.

fn from(content: ToServer) -> Message<ToServer>

Convert a ToServer enum into a Message

This creates a Message with the given content and empty extra_headers.