Struct AdminGuard 

pub struct AdminGuard { /* private fields */ }

RAII guard for automatic admin client cleanup

This wrapper ensures that the admin client is properly shut down when it goes out of scope, preventing resource leaks and dangling connections.

Examples

use rocketmq_admin_core::core::admin::{AdminBuilder, AdminGuard};

async fn process_topics() -> RocketMQResult<()> {
    let admin = AdminBuilder::new()
        .namesrv_addr("127.0.0.1:9876")
        .build_with_guard()
        .await?;

    // Use admin through Deref
    let result = admin.examine_topic_route_info("MyTopic").await?;

    Ok(())
} // admin.shutdown() called automatically here

Implementations

impl AdminGuard

pub async fn shutdown(self)

Manually shutdown the admin client

This consumes the guard and prevents the automatic Drop shutdown.

Examples found in repository

examples/admin_builder_pattern.rs (line 154)

async fn example_explicit_shutdown() -> RocketMQResult<()> {
    println!("\n=== Example 5: Explicit Shutdown ===");

    let admin = AdminBuilder::new()
        .namesrv_addr("127.0.0.1:9876")
        .instance_name("explicit-shutdown-example")
        .build_with_guard()
        .await?;

    // Use admin...
    println!("Admin client started successfully");

    // Explicit shutdown with logging
    println!("Shutting down admin client...");
    admin.shutdown().await;
    println!("Shutdown complete");

    Ok(())
}

pub fn inner(&self) -> &DefaultMQAdminExt

Get a reference to the inner admin client

pub fn inner_mut(&mut self) -> &mut DefaultMQAdminExt

Get a mutable reference to the inner admin client

Methods from Deref<Target = DefaultMQAdminExt>

pub fn client_config(&self) -> &ArcMut<ClientConfig>

pub fn client_config_mut(&mut self) -> &mut ArcMut<ClientConfig>

pub async fn create_acl_with_acl_info( &self, broker_addr: CheetahString, acl_info: AclInfo, ) -> RocketMQResult<()>

pub async fn update_acl_with_acl_info( &self, broker_addr: CheetahString, acl_info: AclInfo, ) -> RocketMQResult<()>

pub async fn create_user_with_user_info( &self, broker_addr: CheetahString, user_info: UserInfo, ) -> RocketMQResult<()>

pub async fn update_user_with_user_info( &self, broker_addr: CheetahString, user_info: UserInfo, ) -> RocketMQResult<()>

pub async fn pull_message_from_queue( &self, broker_addr: &str, mq: &MessageQueue, sub_expression: &str, offset: i64, max_nums: i32, timeout_millis: u64, ) -> RocketMQResult<PullResult>

pub async fn query_message_by_key( &self, cluster_name: Option<CheetahString>, topic: CheetahString, key: CheetahString, max_num: i32, begin_timestamp: i64, end_timestamp: i64, key_type: CheetahString, last_key: Option<CheetahString>, ) -> RocketMQResult<QueryResult>

pub async fn query_message_by_unique_key( &self, cluster_name: Option<CheetahString>, topic: CheetahString, unique_key: CheetahString, max_num: i32, begin_timestamp: i64, end_timestamp: i64, ) -> RocketMQResult<QueryResult>

Trait Implementations

impl AsMut<DefaultMQAdminExt> for AdminGuard

fn as_mut(&mut self) -> &mut DefaultMQAdminExt

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<DefaultMQAdminExt> for AdminGuard

fn as_ref(&self) -> &DefaultMQAdminExt

Converts this type into a shared reference of the (usually inferred) input type.

impl Deref for AdminGuard

type Target = DefaultMQAdminExt

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for AdminGuard

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Drop for AdminGuard

fn drop(&mut self)

Executes the destructor for this type.