Struct MessageBuilder 

pub struct MessageBuilder { /* private fields */ }

Builder for constructing messages.

Examples

use rocketmq_common::common::message::message_builder::MessageBuilder;

let msg = MessageBuilder::new()
    .topic("test-topic")
    .body_slice(b"hello world")
    .tags("important")
    .keys(vec!["key1".to_string(), "key2".to_string()])
    .build();

Implementations

impl MessageBuilder

pub fn new() -> Self

Creates a new message builder.

pub fn topic(self, topic: impl Into<CheetahString>) -> Self

Sets the topic name (required).

pub fn body(self, body: impl Into<Bytes>) -> Self

Sets the message body from bytes.

pub fn body_slice(self, body: &[u8]) -> Self

Sets the message body from a byte slice.

pub fn empty_body(self) -> Self

Sets an empty body.

pub fn tags(self, tags: impl Into<CheetahString>) -> Self

Sets the message tags.

pub fn keys(self, keys: Vec<String>) -> Self

Sets the message keys from a vector.

pub fn key(self, key: impl Into<CheetahString>) -> Self

Sets a single message key.

pub fn flag(self, flag: MessageFlag) -> Self

Sets the message flag.

pub fn flag_bits(self, bits: i32) -> Self

Sets the message flag from raw bits.

pub fn delay_level(self, level: i32) -> Self

Sets the delay time level (1-18 for predefined levels).

pub fn delay_secs(self, secs: u64) -> Self

Sets the delay time in seconds.

pub fn delay_millis(self, millis: u64) -> Self

Sets the delay time in milliseconds.

pub fn deliver_time_ms(self, time_ms: u64) -> Self

Sets the delivery time in milliseconds.

pub fn wait_store_msg_ok(self, wait: bool) -> Self

Sets whether to wait for store confirmation.

pub fn transaction_id(self, id: impl Into<CheetahString>) -> Self

Sets the transaction ID.

pub fn buyer_id(self, buyer_id: impl Into<CheetahString>) -> Self

Sets the buyer ID.

pub fn instance_id(self, instance_id: impl Into<CheetahString>) -> Self

Sets the instance ID.

pub fn correlation_id(self, correlation_id: impl Into<CheetahString>) -> Self

Sets the correlation ID.

pub fn sharding_key(self, sharding_key: impl Into<CheetahString>) -> Self

Sets the sharding key.

pub fn trace_switch(self, enabled: bool) -> Self

Sets the trace switch.

pub fn property( self, key: MessagePropertyKey, value: impl Into<CheetahString>, ) -> Self

Sets a custom property directly using MessagePropertyKey.

pub fn raw_property( self, key: impl Into<CheetahString>, value: impl Into<CheetahString>, ) -> RocketMQResult<Self>

Sets a raw property with string key (for advanced use).

Errors

Returns an error if the property name is reserved by the system.

pub fn build(self) -> RocketMQResult<Message>

Builds the message.

Errors

Returns an error if required fields (topic) are not set.

pub fn build_unchecked(self) -> Message

Builds the message, panicking if validation fails.

This is convenient for test code where you know the message is valid.

Trait Implementations

impl Default for MessageBuilder

fn default() -> MessageBuilder

Returns the “default value” for a type.