rocketmq_client_rust::consumer::lite_pull_consumer

Trait LitePullConsumerLocal

Source 
pub trait LitePullConsumerLocal: Sync {

Show 30 methods    // Required methods
    async fn start(&self) -> RocketMQResult<()>;
    async fn shutdown(&self);
    async fn is_running(&self) -> bool;
    async fn subscribe(&self, topic: &str) -> RocketMQResult<()>;
    async fn subscribe_with_expression(
        &self,
        topic: &str,
        sub_expression: &str,
    ) -> RocketMQResult<()>;
    async fn subscribe_with_listener<MQL>(
        &self,
        topic: &str,
        sub_expression: &str,
        listener: MQL,
    ) -> RocketMQResult<()>
       where MQL: MessageQueueListener;
    async fn subscribe_with_selector(
        &self,
        topic: &str,
        selector: Option<MessageSelector>,
    ) -> RocketMQResult<()>;
    async fn unsubscribe(&self, topic: &str);
    async fn assignment(&self) -> RocketMQResult<HashSet<MessageQueue>>;
    async fn assign(&self, message_queues: Vec<MessageQueue>);
    async fn set_sub_expression_for_assign(
        &self,
        topic: &str,
        sub_expression: &str,
    );
    async fn poll(&self) -> Vec<MessageExt>;
    async fn poll_with_timeout(&self, timeout: u64) -> Vec<MessageExt>;
    async fn seek(
        &self,
        message_queue: &MessageQueue,
        offset: i64,
    ) -> RocketMQResult<()>;
    async fn pause(&self, message_queues: Vec<MessageQueue>);
    async fn resume(&self, message_queues: Vec<MessageQueue>);
    async fn is_auto_commit(&self) -> bool;
    async fn set_auto_commit(&self, auto_commit: bool);
    async fn fetch_message_queues(
        &self,
        topic: &str,
    ) -> RocketMQResult<Vec<MessageQueue>>;
    async fn offset_for_timestamp(
        &self,
        message_queue: &MessageQueue,
        timestamp: u64,
    ) -> RocketMQResult<i64>;
    async fn commit_sync(&self);
    async fn commit_sync_with_map(
        &self,
        offset_map: HashMap<MessageQueue, i64>,
        persist: bool,
    );
    async fn commit(&self);
    async fn commit_with_map(
        &self,
        offset_map: HashMap<MessageQueue, i64>,
        persist: bool,
    );
    async fn commit_with_set(
        &self,
        message_queues: HashSet<MessageQueue>,
        persist: bool,
    );
    async fn committed(
        &self,
        message_queue: &MessageQueue,
    ) -> RocketMQResult<i64>;
    async fn register_topic_message_queue_change_listener<TL>(
        &self,
        topic: &str,
        listener: TL,
    ) -> RocketMQResult<()>
       where TL: TopicMessageQueueChangeListener;
    async fn update_name_server_address(&self, name_server_address: &str);
    async fn seek_to_begin(
        &self,
        message_queue: &MessageQueue,
    ) -> RocketMQResult<()>;
    async fn seek_to_end(
        &self,
        message_queue: &MessageQueue,
    ) -> RocketMQResult<()>;

}

Required Methods§

Source

async fn start(&self) -> RocketMQResult<()>

Starts the LitePullConsumer.

§Returns
  • rocketmq_error::RocketMQResult<()> - An empty result indicating success or failure.
Source

async fn shutdown(&self)

Shuts down the LitePullConsumer.

Source

async fn is_running(&self) -> bool

Checks if the LitePullConsumer is running.

§Returns
  • bool - true if the consumer is running, false otherwise.
Source

async fn subscribe(&self, topic: &str) -> RocketMQResult<()>

Subscribes to a topic.

§Arguments
  • topic - The name of the topic to subscribe to.
§Returns
  • rocketmq_error::RocketMQResult<()> - An empty result indicating success or failure.
Source

async fn subscribe_with_expression( &self, topic: &str, sub_expression: &str, ) -> RocketMQResult<()>

Subscribes to a topic with a subscription expression.

§Arguments
  • topic - The name of the topic to subscribe to.
  • sub_expression - The subscription expression.
§Returns
  • rocketmq_error::RocketMQResult<()> - An empty result indicating success or failure.
Source

async fn subscribe_with_listener<MQL>( &self, topic: &str, sub_expression: &str, listener: MQL, ) -> RocketMQResult<()>
where MQL: MessageQueueListener,

Subscribes to a topic with a subscription expression and a message queue listener.

§Arguments
  • topic - The name of the topic to subscribe to.
  • sub_expression - The subscription expression.
  • listener - The message queue listener.
§Returns
  • rocketmq_error::RocketMQResult<()> - An empty result indicating success or failure.
Source

async fn subscribe_with_selector( &self, topic: &str, selector: Option<MessageSelector>, ) -> RocketMQResult<()>

Subscribes to a topic with a message selector.

§Arguments
  • topic - The name of the topic to subscribe to.
  • selector - The message selector.
§Returns
  • rocketmq_error::RocketMQResult<()> - An empty result indicating success or failure.
Source

async fn unsubscribe(&self, topic: &str)

Unsubscribes from a topic.

§Arguments
  • topic - The name of the topic to unsubscribe from.
Source

async fn assignment(&self) -> RocketMQResult<HashSet<MessageQueue>>

Retrieves the current assignment of message queues.

§Returns
  • rocketmq_error::RocketMQResult<HashSet<MessageQueue>> - A set of assigned message queues or an error.
Source

async fn assign(&self, message_queues: Vec<MessageQueue>)

Assigns a list of message queues to the consumer.

§Arguments
  • message_queues - A vector of MessageQueue instances to assign.
Source

async fn set_sub_expression_for_assign(&self, topic: &str, sub_expression: &str)

Sets the subscription expression for an assigned topic.

§Arguments
  • topic - The name of the topic.
  • sub_expression - The subscription expression.
Source

async fn poll(&self) -> Vec<MessageExt>

Polls for messages.

§Returns
  • Vec<MessageExt> - A vector of polled messages.
Source

async fn poll_with_timeout(&self, timeout: u64) -> Vec<MessageExt>

Polls for messages with a timeout.

§Arguments
  • timeout - The timeout duration in milliseconds.
§Returns
  • Vec<MessageExt> - A vector of polled messages.
Source

async fn seek( &self, message_queue: &MessageQueue, offset: i64, ) -> RocketMQResult<()>

Seeks to a specific offset in a message queue.

§Arguments
  • message_queue - The message queue to seek.
  • offset - The offset to seek to.
§Returns
  • rocketmq_error::RocketMQResult<()> - An empty result indicating success or failure.
Source

async fn pause(&self, message_queues: Vec<MessageQueue>)

Pauses message consumption for the specified message queues.

§Arguments
  • message_queues - A vector of MessageQueue instances to pause.
Source

async fn resume(&self, message_queues: Vec<MessageQueue>)

Resumes message consumption for the specified message queues.

§Arguments
  • message_queues - A vector of MessageQueue instances to resume.
Source

async fn is_auto_commit(&self) -> bool

Checks if auto-commit is enabled.

§Returns
  • bool - true if auto-commit is enabled, false otherwise.
Source

async fn set_auto_commit(&self, auto_commit: bool)

Sets the auto-commit mode.

§Arguments
  • auto_commit - true to enable auto-commit, false to disable it.
Source

async fn fetch_message_queues( &self, topic: &str, ) -> RocketMQResult<Vec<MessageQueue>>

Fetches the message queues for a topic.

§Arguments
  • topic - The name of the topic.
§Returns
  • rocketmq_error::RocketMQResult<Vec<MessageQueue>> - A vector of message queues or an error.
Source

async fn offset_for_timestamp( &self, message_queue: &MessageQueue, timestamp: u64, ) -> RocketMQResult<i64>

Retrieves the offset for a given timestamp in a message queue.

§Arguments
  • message_queue - The message queue to query.
  • timestamp - The timestamp to query the offset for.
§Returns
  • rocketmq_error::RocketMQResult<i64> - The offset corresponding to the given timestamp or an error.
Source

async fn commit_sync(&self)

Commits the current offsets synchronously.

Source

async fn commit_sync_with_map( &self, offset_map: HashMap<MessageQueue, i64>, persist: bool, )

Commits the provided offsets synchronously.

§Arguments
  • offset_map - A map of message queues to offsets.
  • persist - Whether to persist the offsets.
Source

async fn commit(&self)

Commits the current offsets.

Source

async fn commit_with_map( &self, offset_map: HashMap<MessageQueue, i64>, persist: bool, )

Commits the provided offsets.

§Arguments
  • offset_map - A map of message queues to offsets.
  • persist - Whether to persist the offsets.
Source

async fn commit_with_set( &self, message_queues: HashSet<MessageQueue>, persist: bool, )

Commits the offsets for the provided message queues.

§Arguments
  • message_queues - A set of message queues to commit offsets for.
  • persist - Whether to persist the offsets.
Source

async fn committed(&self, message_queue: &MessageQueue) -> RocketMQResult<i64>

Retrieves the committed offset for a message queue.

§Arguments
  • message_queue - The message queue to query.
§Returns
  • rocketmq_error::RocketMQResult<i64> - The committed offset or an error.
Source

async fn register_topic_message_queue_change_listener<TL>( &self, topic: &str, listener: TL, ) -> RocketMQResult<()>
where TL: TopicMessageQueueChangeListener,

Registers a listener for changes to the message queues of a topic.

§Arguments
  • topic - The name of the topic.
  • listener - The listener to register.
§Returns
  • rocketmq_error::RocketMQResult<()> - An empty result indicating success or failure.
Source

async fn update_name_server_address(&self, name_server_address: &str)

Updates the name server address.

§Arguments
  • name_server_address - The new name server address.
Source

async fn seek_to_begin( &self, message_queue: &MessageQueue, ) -> RocketMQResult<()>

Seeks to the beginning of a message queue.

§Arguments
  • message_queue - The message queue to seek.
§Returns
  • rocketmq_error::RocketMQResult<()> - An empty result indicating success or failure.
Source

async fn seek_to_end(&self, message_queue: &MessageQueue) -> RocketMQResult<()>

Seeks to the end of a message queue.

§Arguments
  • message_queue - The message queue to seek.
§Returns
  • rocketmq_error::RocketMQResult<()> - An empty result indicating success or failure.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors§

Source§

impl<TraitVariantBlanketType: LitePullConsumer> LitePullConsumerLocal for TraitVariantBlanketType