Struct ConsumeMessageContext 

pub struct ConsumeMessageContext<'a> {
    pub consumer_group: CheetahString,
    pub msg_list: &'a [Arc<MessageExt>],
    pub mq: Option<MessageQueue>,
    pub success: bool,
    pub status: CheetahString,
    pub mq_trace_context: Option<Arc<dyn Any + Send + Sync>>,
    pub props: HashMap<CheetahString, CheetahString>,
    pub namespace: CheetahString,
    pub access_channel: Option<AccessChannel>,
}

Context information for message consumption operations.

Contains metadata about a message consumption attempt, including the consumer group, message list, target queue, and consumption result. This context is passed to consumption hooks for monitoring and tracing purposes.

Examples

use rocketmq_client::ConsumeMessageContext;
use cheetah_string::CheetahString;

let context = ConsumeMessageContext::new(
    CheetahString::from("test_group"),
    &messages
).with_success(true)
  .with_status("CONSUME_SUCCESS");

Fields

consumer_group: CheetahString

Consumer group name

msg_list: &'a [Arc<MessageExt>]

List of messages being consumed

mq: Option<MessageQueue>

Target message queue

success: bool

Whether consumption succeeded

status: CheetahString

Consumption status description

mq_trace_context: Option<Arc<dyn Any + Send + Sync>>

Trace context for distributed tracing

props: HashMap<CheetahString, CheetahString>

Additional properties

namespace: CheetahString

Namespace

access_channel: Option<AccessChannel>

Access channel

Implementations

impl<'a> ConsumeMessageContext<'a>

pub fn new( consumer_group: CheetahString, msg_list: &'a [Arc<MessageExt>], ) -> Self

Creates a new consumption context.

pub fn with_mq(self, mq: MessageQueue) -> Self

Sets the message queue.

pub fn with_success(self, success: bool) -> Self

Sets the success flag.

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

Sets the status description.

pub fn with_trace_context(self, context: Arc<dyn Any + Send + Sync>) -> Self

Sets the trace context.

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

Sets the namespace.

pub fn with_access_channel(self, channel: AccessChannel) -> Self

Sets the access channel.

pub fn add_prop( &mut self, key: impl Into<CheetahString>, value: impl Into<CheetahString>, )

Adds a property.

pub fn message_count(&self) -> usize

Gets the number of messages in this context.

Trait Implementations

impl<'a> Debug for ConsumeMessageContext<'a>

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

Formats the value using the given formatter.

impl<'a> Default for ConsumeMessageContext<'a>

fn default() -> Self

Returns the “default value” for a type.

impl<'a> Display for ConsumeMessageContext<'a>

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

Formats the value using the given formatter.