Struct BrokerMessage 

pub struct BrokerMessage { /* private fields */ }

Broker internal message representation

Contains extension information needed by the Broker when processing messages, such as tags_code, encoding cache, etc. Only used internally by the Broker, not exposed to clients.

Use Cases

• Broker receives messages and constructs BrokerMessage for writing to CommitLog
• Store module internal message passing
• Message filtering and index building

Implementations

impl BrokerMessage

pub fn new( envelope: MessageEnvelope, tags_code: i64, properties_string: CheetahString, version: MessageVersion, ) -> Self

Creates a new broker message

pub fn from_envelope(envelope: MessageEnvelope) -> Self

Creates from message envelope (automatically calculates tags_code and properties_string)

pub fn envelope(&self) -> &MessageEnvelope

Gets the message envelope

pub fn envelope_mut(&mut self) -> &mut MessageEnvelope

Gets the mutable message envelope

pub fn into_envelope(self) -> MessageEnvelope

Consumes self and returns the envelope

pub fn tags_code(&self) -> i64

Gets the tags hash code

pub fn properties_string(&self) -> &str

Gets the serialized properties string

pub fn version(&self) -> MessageVersion

Gets the message version

pub fn encoded_buff(&self) -> Option<&BytesMut>

Gets the encoding cache

pub fn encoded_buff_mut(&mut self) -> Option<&mut BytesMut>

Gets the mutable encoding cache

pub fn is_encode_completed(&self) -> bool

Checks if encoding is completed

pub fn set_encoded_buff(&mut self, buff: BytesMut)

Sets the encoding cache

pub fn take_encoded_buff(&mut self) -> Option<BytesMut>

Takes the encoding cache

pub fn clear_encoded_buff(&mut self)

Clears the encoding cache

pub fn set_version(&mut self, version: MessageVersion)

Sets the message version

pub fn set_tags_code(&mut self, tags_code: i64)

Sets the tags code

pub fn set_properties_string(&mut self, properties_string: CheetahString)

Sets the properties string

pub fn calculate_tags_code(tags: &str) -> i64

Calculates the hash code for tags

pub fn delete_property(&mut self, name: &str)

Deletes a property (synchronizes properties_string)

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

Gets a property value

Trait Implementations

impl Debug for BrokerMessage

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

Formats the value using the given formatter.

impl Default for BrokerMessage

fn default() -> Self

Returns the “default value” for a type.

impl Display for BrokerMessage

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

Formats the value using the given formatter.

impl From<BrokerMessage> for MessageExtBrokerInner

fn from(broker_msg: BrokerMessage) -> Self

Converts to this type from the input type.

impl From<MessageExtBrokerInner> for BrokerMessage

fn from(inner: MessageExtBrokerInner) -> Self

Converts to this type from the input type.

impl MessageTrait for BrokerMessage

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.