Skip to main content Crate rocketmq_client_rust Copy item path Source prelude Minimal imports for common Client producer and consumer use cases. client_broker_err Create a broker operation error mq_client_err Create a client error with optional response code AckResult AclClientRPCHook Client-side ACL RPC hook compatible with the Java RocketMQ client. AclConstants Java-compatible ACL constants. AclSigner Java-compatible ACL signer facade. AclUtils Java-compatible ACL utility facade. AdminClient AdminToolResult AllocateMessageQueueAveragely Allocates contiguous queue ranges as evenly as possible. AllocateMessageQueueAveragelyByCircle Allocates every Nth queue to each consumer. AllocateMessageQueueByConfig Returns a statically configured set of queues. AllocateMessageQueueByMachineRoom Limits allocation to selected broker machine rooms. AllocateMessageQueueByMachineRoomNearby Prefers queues local to a consumer and shares queues from rooms without consumers. AllocateMessageQueueConsistentHash Assigns queues through a consistent hash ring of consumer ids. AsyncTraceDispatcher Asynchronous trace dispatcher for RocketMQ message tracing. BatchSendCallbackRequest Callback-based batch send with an optional explicit queue. BatchSendRequest Batch send with destination and deadline policy. BrokerConfigAllowlisted Sanitized allowlisted Broker fields required by supervised configuration
patching. Arbitrary Broker properties never cross this read boundary. BrokerFilter BrokerMutationConfigState Six-key Broker state allowed into mutation preflight. BrokerReadFailure Address-free evidence for one failed Broker read. CheckForbiddenContext Context information for forbidden operation checks. ClientConfig ClientError Opaque client boundary error backed by one shared canonical error. ClientInstanceHandle Opaque compatibility handle for the Client instance owned by the Proxy
Cluster worker. ClientMetrics ClientOptions Client configuration plus an optional typed NameServer discovery source. ClientPool ClientRuntime Explicit lifecycle owner for all RocketMQ clients in one application domain. ClientRuntimeConfig Configuration for one explicitly owned RocketMQ client runtime. ClientSession Identifies the application-owned runtime and task owner shared by a set of
client capabilities. ConditionalConsumerOffsetOutcome Exact conditional consumer-offset update result. ConsumeConcurrentlyContext ConsumeMessageContext Context information for message consumption operations. ConsumeMessageOpenTracingHookImpl Deprecated ConsumeOrderlyContext ConsumeRequest ConsumeStatsReadResult Multi-Broker consumer statistics together with completeness evidence. ConsumerClient ControllableOffset DefaultLitePullConsumer Default implementation of a lite pull consumer. DefaultLitePullConsumerBuilder Builder for creating a DefaultLitePullConsumer DefaultMQAdminExt Java-style Admin facade that owns a self-wired DefaultMQAdminExtImpl. DefaultMQAdminExtImpl DefaultMQProducer DefaultMQPullConsumer Deprecated Java Classic Pull compatibility facade backed by the shared Rust client runtime. DefaultMQPullConsumerBuilder Builds a Classic Pull compatibility facade on the shared client runtime. DefaultMQPullConsumerImpl Deprecated Functional implementation handle retained under the Java compatibility name. DefaultMQPushConsumer DefaultMQPushConsumerBuilder DnsName A normalized ASCII DNS name used as a logical NameServer authority. DoNothingClientRemotingProcessor EndTransactionOpenTracingHookImpl Deprecated InfrastructureObservationReadError Address-free error returned by infrastructure observation RPCs. LocalFileOffsetStore MQBrokerException MQClientAPIFactory MQClientException MQFaultStrategy MQHelper Deprecated MQPullConsumerScheduleService Deprecated MessageListener MessageMetadataRead Fixed, body-free metadata returned by the read-only message lookup. MessageSelector Selects messages at the server side based on filter expressions. MessageUtil MutationConsumerOffsetPreview Pure preflight row for one logical Broker queue; no network address escapes. MutationMessageRequestMode Exact request-mode value returned by a selected Broker master. MutationMessageRequestModeOutcome Conditional request-mode result containing only the current typed value. MutationStateCasOutcome Result of one presence/version conditional replacement. MutationSubscriptionGroupConfig Complete allowlisted Subscription Group state used by supervised replacement. MutationSubscriptionGroupConfigState Presence-aware Subscription Group preflight result. MutationTopicConfig Complete allowlisted Topic state used by a supervised replace operation. MutationTopicConfigState Presence-aware Topic preflight result. MutationTopicConfigVersioned Allowlisted Topic state returned to an isolated mutation preflight. NameServerAuthority A canonical host:port NameServer authority. NameServerDiscoveryConfig Typed NameServer discovery configuration. NameServerDiscoveryStatus Read-only, endpoint-free discovery status suitable for diagnostics and readiness policies. NameserverAccessConfig NamespaceRpcHook RPC hook that injects namespace metadata into outgoing requests. NotifyResult OffsetNotFoundException OffsetSerialize OffsetSerializeWrapper Permission Java-compatible ACL permission bits. PopResult ProducerClient ProducerConfig PullOptions Validated parameters for one Classic Pull request. PullResult PullResultExt PullTaskContext Deprecated PullTaskImpl Deprecated ReadWriteCASLock Java-compatible CAS read/write lock used by producer backpressure paths. RebalanceImpl RebalancePullImpl Deprecated RecallRequest Recall a previously sent message. RemoteBrokerOffsetStore RequestReplyCallbackRequest Callback-based request/reply invocation. RequestReplyRequest Request/reply invocation with an optional explicit queue. RequestTimeoutException ResolvedNameServerEndpoint A physical endpoint resolved from a logical NameServer authority. RouteClient SelectMessageQueueByHash A message queue selector that uses hash-based routing. SelectMessageQueueByMachineRoom SelectMessageQueueByRandom A message queue selector that uses random selection. SelectedRequestReplyCallbackRequest Callback-based selector request/reply invocation. SelectedRequestReplyRequest Selector-based request/reply invocation. SelectedSendCallbackRequest Callback-based selector send. SelectedSendRequest Selector-based send without duplicating destination overloads. SendCallbackRequest Callback-based send with an optional explicit queue. SendMessageOpenTracingHookImpl Deprecated SendRequest One message send with destination, completion mode, and deadline policy. SendResult Producer send result without client lifecycle state. SessionCredentials SubscriptionGroupConfigPatch Closed Subscription Group fields accepted by the supervised version-CAS
operation. SubscriptionGroupConfigVersioned Subscription Group configuration paired with the Broker’s monotonic
metadata version. TelemetryHandle Cloneable telemetry capability injected into business components. ThreadLocalIndex TopicConfigPatch Closed Topic fields accepted by the supervised version-CAS operation. TopicConfigVersioned Topic configuration paired with the Broker’s monotonic metadata version. TopicCreateRequest Topic creation input shared by both legacy overloads. TopicOffsetMutationOutcome Failure-aware results for all exact broker/queue targets reached by one offset mutation. TopicOffsetMutationTargetOutcome One broker or queue result from a detailed reset/skip workflow. TraceDataEncoder Encodes and decodes trace data for RocketMQ message tracing. TransactionClient TransactionMQProducer TransactionMQProducerBuilder TransactionSendRequest Transactional send input. TransactionSendResult AckStatus AdminToolsResultCodeEnum BrokerConfigPatchOutcome Result of one generation-checked broker configuration patch. ConsumeConcurrentlyStatus ConsumeOrderlyStatus ConsumerConnectionRead ConsumerGroupConfigRead ConsumerProgressRead ConsumerTuningProfile InfrastructureObservationReadErrorCode Stable failure classification for exact infrastructure observation RPCs. LocalTransactionState MutationExpectedMessageRequestMode Closed request-mode precondition. MutationExpectedState Closed presence/version condition for full supervised metadata replacement. MutationPersistenceState Durable state of an accepted supervised mutation. MutationTopicMessageType Closed Topic message types supported by supervised replacement. NameServerDiscoveryErrorCategory Sanitized DNS failure categories. Resolver messages and queried names are not exposed. NameServerDiscoveryFreshness Freshness of the last-known-good discovery snapshot. NameServerDiscoverySourceKind Low-cardinality discovery source categories exposed by status snapshots. NameServerSource Supported NameServer discovery sources. OffsetStore The active offset storage backend for a message consumer. PopStatus ProducerQueryRequest Producer-side metadata query. ProducerQueryResponse Closed result set corresponding to ProducerQueryRequest PullStatus Consumer pull status. ReadFailureCode Stable failure classification for one exact Broker read. ReadOffsetType SendDestination Destination selected before entering the send capability. SendMode Completion contract for one send request. SendStatus Outcome reported by a producer send operation. SubscriptionGroupConfigPatchOutcome Result of one version-checked Subscription Group configuration patch. TopicConfigPatchOutcome Result of one version-checked Topic configuration patch. TopicOffsetMutationFailureCode Closed failure categories for one detailed consumer-offset target. TraceDispatcherOperation The type of tracing operation being performed. TraceDispatcherType Type of trace dispatcher indicating the source of trace data. TraceType AckCallback Trait representing an acknowledgment callback.
This trait defines two methods: on_success and on_exception. AllocateMessageQueueStrategy Runtime-neutral queue allocation contract. AssignmentControl AuthAdmin BrokerAdmin CheckForbiddenHook Hook for checking forbidden message sending operations. ClassicPullCallback Callback for an asynchronous Classic Pull request. ClientSessionProvider Implemented by concrete client handles that borrow one shared session. ConsumeMessageHook Hook for message consumption lifecycle events. ConsumerAdmin ConsumerLifecycle ConsumerOffsetControl HashFunction Converts a stable string key into a ring position. JavaHashCode Java-compatible hashCode support for SelectMessageQueueByHash MQAdmin Trait defining administrative operations for a Message Queue (MQ). MQAdminConsumerObservationReadExt MQAdminInfrastructureObservationReadExt Additive read-only access to four existing exact-target admin RPCs. MQAdminMessageReadExt Additive read-only capability for fixed, body-free message metadata. MQAdminMutationExt Explicit RocketMQ mutation capability. MQAdminReadExt MQAdminTopicInventoryReadExt Additive read-only capability for a NameServer Topic inventory. MQAdminTopicStatsReadExt Additive capability for reading Topic statistics from one already resolved
Broker target. Address resolution remains the responsibility of a trusted
adapter and addresses never cross this trait’s result boundary. MQConsumer MQConsumerInner The MQConsumerInnerLocal trait defines the core functionalities required for a local MQ
consumer. It extends the MQConsumerInnerAny trait and requires implementations to be Sync
and 'static. MQPullConsumer Deprecated Common async surface implemented by Classic Pull facades. MQPushConsumer Defines the push-consumer interface for RocketMQ. MachineRoomResolver Resolves the deployment room of brokers and consumers. MessageListenerConcurrently A trait for processing messages concurrently. MessageListenerOrderly A trait for processing messages in order. MessagePoll MessageQuery Producer metadata and message-query capability. MessageQueueListener A listener that is notified when message queue allocation changes during consumer rebalancing. MessageQueueSelector A trait for selecting a message queue from a list of available queues. MessageRecall Message recall capability. MessageSend Normal send, batch-send, and one-way capability. MqClientAdmin MqClientAdminInner OffsetAdmin PopCallback Trait for handling the results of a pop operation. ProducerLifecycle Producer startup and shutdown capability. ProducerTopicAdmin Producer topic-administration capability. PullCallback PullTaskCallback Deprecated RequestCallback RequestReply Request/reply capability. Resolver RouteAdmin SendCallback Callback trait for handling asynchronous message send results. ServiceDetector Detects whether a remote service endpoint is healthy. SubscriptionControl A consumer that pulls messages from brokers on demand, providing explicit control over
fetch timing, offset management, and queue assignment. TopicAdmin TopicMessageQueueChangeListener A trait for listening to changes in the message queues of a specific topic. TraceDispatcher A dispatcher that manages the collection and transmission of message tracing data. TransactionCheckListener Deprecated TransactionListener Listener for handling transactional message operations. TransactionSend Transactional send capability implemented only by transaction producers. client_config_for_managed_domain Isolates a managed Client owner in its injected crate::ClientPool pop_retry_subscription_topics Returns both POP retry topics that a push-mode subscription may inherit
while a Broker is inside the supported v1/v2 migration window. resolve_pop_retry_topic Resolves an observed POP retry topic through the shared v1/v2 codec. rpc_hook_from_outbound_signer AbstractAllocateMessageQueueStrategy AckCallbackFn Type alias for a function that acts as an acknowledgment callback.
The function takes two optional arguments: an AckResult and an error. AclException Java-compatible ACL exception type. AllocateMachineRoomNearby ArcMessageListenerConcurrently Type-erased message listener for storage and cross-boundary passing. ArcMessageListenerOrderly Type-erased message listener for storage and cross-boundary passing. ArcMessageQueueListener Type alias for an atomically reference-counted message queue listener. ArcSendCallback Type alias for dynamically dispatched send callbacks. ArcTraceDispatcher Type alias for an atomically reference-counted trace dispatcher. ArcTransactionListener Thread-safe shared reference to a TransactionListener ClientResult Result returned by RocketMQ client operations. ClientRpcHook ConsumeMessageHookArc Type alias for a thread-safe hook reference. MessageQueueSelectorFn Type-erased message queue selector function for storage and cross-boundary passing. PopCallbackFn Type alias for a callback function that handles the result of a pop operation. PullCallbackFn PullOutcome Owned, runtime-neutral pull result used across crate boundaries. QueryResult SigningAlgorithm Java-compatible ACL signing algorithm type.