iggy_common 0.11.0-edge.2

// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License.  You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied.  See the License for the
// specific language governing permissions and limitations
// under the License.

use crate::{ClusterMetadata, IggyError};
use async_trait::async_trait;

/// This trait defines the methods to interact with the cluster module.
#[async_trait]
pub trait ClusterClient {
    /// Get the metadata of the cluster including node information, roles, and status.
    ///
    /// Requires authentication; leader placement happens after login.
    async fn get_cluster_metadata(&self) -> Result<ClusterMetadata, IggyError>;
}