Struct MessageEnvelope 

pub struct MessageEnvelope { /* private fields */ }

Complete message envelope (stored message)

Represents a message that has been received and stored by the Broker, containing complete lifecycle information.

Use Cases

• Consumer receiving messages
• Message query and tracking
• Message passing between Broker internal modules

Implementations

impl MessageEnvelope

pub fn new( message: Message, routing: RoutingContext, storage: StorageMetadata, msg_id: CheetahString, body_crc: u32, reconsume_times: i32, prepared_transaction_offset: i64, ) -> Self

Creates a new message envelope

pub fn message(&self) -> &Message

Gets the message reference

pub fn message_mut(&mut self) -> &mut Message

Gets the mutable message reference

pub fn topic(&self) -> &CheetahString

Gets the message topic

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

Gets the message body

pub fn properties(&self) -> &HashMap<CheetahString, CheetahString>

Gets the message properties

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

Gets the message tags

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

Gets the message keys

pub fn flag(&self) -> i32

Gets the message flag

pub fn routing(&self) -> &RoutingContext

Gets the routing context

pub fn born_host(&self) -> SocketAddr

Gets the message sender’s client address

pub fn born_timestamp(&self) -> i64

Gets the message creation timestamp

pub fn sys_flag(&self) -> i32

Gets the system flag bits

pub fn born_host_bytes(&self) -> Bytes

Gets the born host bytes

pub fn storage(&self) -> &StorageMetadata

Gets the storage metadata

pub fn broker_name(&self) -> &str

Gets the broker name

pub fn queue_id(&self) -> i32

Gets the queue ID

pub fn queue_offset(&self) -> i64

Gets the queue logical offset

pub fn commit_log_offset(&self) -> i64

Gets the CommitLog physical offset

pub fn store_timestamp(&self) -> i64

Gets the storage timestamp

pub fn store_host(&self) -> SocketAddr

Gets the storage host address

pub fn store_size(&self) -> i32

Gets the storage size in bytes

pub fn store_host_bytes(&self) -> Bytes

Gets the store host bytes

pub fn msg_id(&self) -> &CheetahString

Gets the message ID (offset-based)

pub fn client_msg_id(&self) -> CheetahString

Gets the client message ID (UNIQ_ID preferred, otherwise returns offset msg_id)

This is the client-side message ID, preferring UNIQ_ID (globally unique)

pub fn body_crc(&self) -> u32

Gets the message body CRC

pub fn reconsume_times(&self) -> i32

Gets the reconsume times

pub fn prepared_transaction_offset(&self) -> i64

Gets the prepared transaction offset

Trait Implementations

impl Clone for MessageEnvelope

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MessageEnvelope

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

Formats the value using the given formatter.

impl Default for MessageEnvelope

fn default() -> Self

Returns the “default value” for a type.

impl Display for MessageEnvelope

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

Formats the value using the given formatter.

impl From<MessageEnvelope> for MessageExt

fn from(envelope: MessageEnvelope) -> Self

Converts to this type from the input type.

impl From<MessageExt> for MessageEnvelope

fn from(ext: MessageExt) -> Self

Converts to this type from the input type.

impl MessageTrait for MessageEnvelope

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, ) -> Result<()>

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 priority(&self) -> i32

Returns the message priority, or -1 if not set or not parseable.

fn try_set_priority(&mut self, priority: i32) -> Result<()>

Sets the message priority, matching Java’s non-negative validation.

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.

fn into_message(self) -> Message

where Self: Sized,

Converts this value into the concrete producer message representation.