Struct nats::Message

pub struct Message {
    pub subject: String,
    pub reply: Option<String>,
    pub data: Vec<u8>,
    pub headers: Option<Headers>,
    // some fields omitted
}

A message received on a subject.

Fields

subject: String

The subject this message came from.

reply: Option<String>

Optional reply subject that may be used for sending a response to this message.

data: Vec<u8>

The message contents.

headers: Option<Headers>

Optional headers associated with this Message.

Implementations

impl Message

pub fn respond(&self, msg: impl AsRef<[u8]>) -> Result<()>

Respond to a request message.

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

Acknowledge a JetStream message with a default acknowledgement. See AckKind documentation for details of what other types of acks are available. If you need to send a non-default ack, use the ack_kind method below. If you need to block until the server acks your ack, use the double_ack method instead.

Returns immediately if this message has already been double-acked.

Requires the jetstream feature.

pub fn ack_kind(&self, ack_kind: AckKind) -> Result<()>

Acknowledge a JetStream message. See AckKind documentation for details of what each variant means. If you need to block until the server acks your ack, use the double_ack method instead.

Does not check whether this message has already been double-acked.

Requires the jetstream feature.

pub fn double_ack(&self, ack_kind: AckKind) -> Result<()>

Acknowledge a JetStream message and wait for acknowledgement from the server that it has received our ack. Retry acknowledgement until we receive a response. See AckKind documentation for details of what each variant means.

Returns immediately if this message has already been double-acked.

Requires the jetstream feature.

pub fn jetstream_message_info(&self) -> Option<JetStreamMessageInfo<'_>>

Returns the JetStream message ID if this is a JetStream message. Returns None if this is not a JetStream message with headers set.

Requires the jetstream feature.

Trait Implementations

impl Clone for Message

fn clone(&self) -> Message

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Message

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

Formats the value using the given formatter.

impl Display for Message

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

Formats the value using the given formatter.