Struct Message 

pub struct Message { /* private fields */ }

Implementations

impl Message

pub fn builder() -> MessageBuilder

Creates a new message builder.

This is the recommended way to create messages.

Examples

use rocketmq_common::common::message::message_single::Message;

let msg = Message::builder()
    .topic("test-topic")
    .body_slice(b"hello world")
    .tags("important")
    .build_unchecked();

pub fn new(topic: impl Into<CheetahString>, body: &[u8]) -> Self

👎Deprecated since 0.8.0:

Use Message::builder() instead

Create a new message with topic and body slice (will copy)

pub fn new_with_bytes(topic: impl Into<CheetahString>, body: Bytes) -> Self

👎Deprecated since 0.8.0:

Use Message::builder() instead

Create a new message with topic and Bytes (zero-copy)

pub fn new_with_vec(topic: impl Into<CheetahString>, body: Vec<u8>) -> Self

👎Deprecated since 0.8.0:

Use Message::builder() instead

Create a new message with topic and Vec (zero-copy conversion to Bytes)

pub fn new_body(topic: impl Into<CheetahString>, body: Option<Bytes>) -> Self

👎Deprecated since 0.8.0:

Use Message::builder() instead

pub fn with_tags( topic: impl Into<CheetahString>, tags: impl Into<CheetahString>, body: &[u8], ) -> Self

👎Deprecated since 0.8.0:

Use Message::builder() instead

Create a message with tags and body slice (will copy)

pub fn with_tags_bytes( topic: impl Into<CheetahString>, tags: impl Into<CheetahString>, body: Bytes, ) -> Self

👎Deprecated since 0.8.0:

Use Message::builder() instead

Create a message with tags and Bytes (zero-copy)

pub fn with_keys( topic: impl Into<CheetahString>, tags: impl Into<CheetahString>, keys: impl Into<CheetahString>, body: &[u8], ) -> Self

👎Deprecated since 0.8.0:

Use Message::builder() instead

Create a message with keys and body slice (will copy)

pub fn with_keys_bytes( topic: impl Into<CheetahString>, tags: impl Into<CheetahString>, keys: impl Into<CheetahString>, body: Bytes, ) -> Self

👎Deprecated since 0.8.0:

Use Message::builder() instead

Create a message with keys and Bytes (zero-copy)

pub fn with_details( topic: impl Into<CheetahString>, tags: impl Into<CheetahString>, keys: impl Into<CheetahString>, flag: i32, body: &[u8], wait_store_msg_ok: bool, ) -> Self

👎Deprecated since 0.8.0:

Use Message::builder() instead

Create message with body slice (will copy data)

pub fn with_details_bytes( topic: impl Into<CheetahString>, tags: impl Into<CheetahString>, keys: impl Into<CheetahString>, flag: i32, body: Bytes, wait_store_msg_ok: bool, ) -> Self

👎Deprecated since 0.8.0:

Use Message::builder() instead

Create message with Bytes (zero-copy)

pub fn with_details_body( topic: impl Into<CheetahString>, tags: impl Into<CheetahString>, keys: impl Into<CheetahString>, flag: i32, body: Option<Bytes>, wait_store_msg_ok: bool, ) -> Self

pub fn set_tags(&mut self, tags: CheetahString)

pub fn set_keys(&mut self, keys: CheetahString)

pub fn clear_property(&mut self, name: impl Into<CheetahString>)

pub fn set_properties( &mut self, properties: HashMap<CheetahString, CheetahString>, )

pub fn get_property(&self, key: &CheetahString) -> Option<CheetahString>

pub fn body(&self) -> Option<Bytes>

pub fn flag(&self) -> i32

pub fn topic(&self) -> &CheetahString

pub fn properties(&self) -> &MessageProperties

pub fn transaction_id(&self) -> Option<&str>

pub fn get_transaction_id(&self) -> Option<&CheetahString>

pub fn get_tags(&self) -> Option<CheetahString>

pub fn is_wait_store_msg_ok(&self) -> bool

pub fn delay_time_level(&self) -> i32

pub fn set_delay_time_level(&mut self, level: i32)

pub fn get_user_property( &self, name: impl Into<CheetahString>, ) -> Option<CheetahString>

pub fn as_any(&self) -> &dyn Any

pub fn set_instance_id(&mut self, instance_id: impl Into<CheetahString>)

pub fn body_slice(&self) -> &[u8]

Returns the message body as a byte slice (borrows).

This is the recommended way to access the message body.

pub fn into_body(self) -> MessageBody

Consumes the message and returns the body.

pub fn tags(&self) -> Option<&str>

Returns the message tags.

pub fn keys(&self) -> Option<Vec<String>>

Returns the message keys as a vector.

pub fn property(&self, key: &str) -> Option<&str>

Returns a property value by key.

pub fn message_flag(&self) -> MessageFlag

Returns the message flag as a type-safe MessageFlag.

pub fn wait_store_msg_ok(&self) -> bool

Returns whether to wait for store confirmation.

pub fn delay_level(&self) -> i32

Returns the delay time level.

pub fn buyer_id(&self) -> Option<&str>

Returns the buyer ID.

pub fn instance_id(&self) -> Option<&str>

Returns the instance ID.

Trait Implementations

impl Clone for Message

fn clone(&self) -> Message

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Message

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

Formats the value using the given formatter.

impl Default for Message

fn default() -> Self

Returns the “default value” for a type.

impl Display for Message

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

Formats the value using the given formatter.

impl MessageTrait for Message

fn put_property(&mut self, key: CheetahString, value: CheetahString)

Adds a property to the message.

fn clear_property(&mut self, name: &str)

Removes the specified property from the message.

fn property(&self, name: &CheetahString) -> Option<CheetahString>

Retrieves a property value.

fn property_ref(&self, name: &CheetahString) -> Option<&CheetahString>

Retrieves a reference to a property value.

fn topic(&self) -> &CheetahString

Returns the topic of the message.

fn set_topic(&mut self, topic: CheetahString)

Sets the topic for the message.

fn get_flag(&self) -> i32

Returns the flag associated with the message.

fn set_flag(&mut self, flag: i32)

Sets the flag for the message.

fn get_body(&self) -> Option<&Bytes>

Returns the body of the message.

fn set_body(&mut self, body: Bytes)

Sets the body of the message.

fn get_properties(&self) -> &HashMap<CheetahString, CheetahString>

Returns all properties associated with the message.

fn set_properties(&mut self, properties: HashMap<CheetahString, CheetahString>)

Sets multiple properties for the message.

fn transaction_id(&self) -> Option<&CheetahString>

Retrieves the transaction ID associated with the message.

fn set_transaction_id(&mut self, transaction_id: CheetahString)

Sets the transaction ID for the message.

fn get_compressed_body_mut(&mut self) -> Option<&mut Bytes>

Returns a mutable reference to the compressed body of the message.

fn get_compressed_body(&self) -> Option<&Bytes>

Returns a reference to the compressed body of the message.

fn set_compressed_body_mut(&mut self, compressed_body: Bytes)

Sets the compressed body of the message.

fn take_body(&mut self) -> Option<Bytes>

Takes ownership of the message body, leaving it empty.

fn as_any(&self) -> &dyn Any

Returns a reference to the message as a trait object.

fn as_any_mut(&mut self) -> &mut dyn Any

Returns a mutable reference to the message as a trait object.

fn set_keys(&mut self, keys: CheetahString)

Sets the keys for the message.

fn put_user_property( &mut self, name: CheetahString, value: CheetahString, ) -> RocketMQResult<()>

Adds a user-defined property to the message.

fn user_property(&self, name: &CheetahString) -> Option<CheetahString>

Retrieves a user-defined property value.

fn user_property_ref(&self, name: &CheetahString) -> Option<&CheetahString>

Retrieves a reference to a user-defined property value.

fn tags(&self) -> Option<CheetahString>

Returns the tags associated with the message.

fn tags_ref(&self) -> Option<&CheetahString>

Returns a reference to the tags associated with the message.

fn set_tags(&mut self, tags: CheetahString)

Sets the tags for the message.

fn get_keys(&self) -> Option<CheetahString>

Returns the keys associated with the message.

fn get_keys_ref(&self) -> Option<&CheetahString>

Returns a reference to the keys associated with the message.

fn set_keys_from_collection(&mut self, key_collection: Vec<String>)

Sets the message keys from a collection, joining them with spaces.

fn delay_time_level(&self) -> i32

Returns the delay time level of the message, or 0 if not set.

fn set_delay_time_level(&mut self, level: i32)

Sets the delay time level for the message.

fn is_wait_store_msg_ok(&self) -> bool

Returns whether the message should wait for store acknowledgment.

fn set_wait_store_msg_ok(&mut self, wait_store_msg_ok: bool)

Sets whether the message should wait for store acknowledgment.

fn set_instance_id(&mut self, instance_id: CheetahString)

Sets the instance ID for the message.

fn buyer_id(&self) -> Option<CheetahString>

Returns the buyer ID associated with the message.

fn buyer_id_ref(&self) -> Option<&CheetahString>

Returns a reference to the buyer ID associated with the message.

fn set_buyer_id(&mut self, buyer_id: CheetahString)

Sets the buyer ID for the message.

fn set_delay_time_sec(&mut self, sec: u64)

Sets the delay time for the message in seconds.

fn get_delay_time_sec(&self) -> u64

Returns the delay time for the message in seconds, or 0 if not set.

fn set_delay_time_ms(&mut self, time_ms: u64)

Sets the delay time for the message in milliseconds.

fn get_delay_time_ms(&self) -> u64

Returns the delay time for the message in milliseconds, or 0 if not set.

fn set_deliver_time_ms(&mut self, time_ms: u64)

Sets the delivery time for the message in milliseconds.

fn get_deliver_time_ms(&self) -> u64

Returns the delivery time for the message in milliseconds, or 0 if not set.