rs-consul 0.13.0

This crate provides access to a set of strongly typed apis to interact with consul (https://www.consul.io/)
Documentation
#[cfg(feature = "metrics")]
use http::StatusCode;

#[cfg(feature = "metrics")]
use std::time::Duration;

/// A struct to hold information about a calls to consul for metrics.
#[cfg(feature = "metrics")]
#[derive(Debug, Clone, Copy)]
pub struct MetricInfo {
    /// The HTTP method used in the call.
    pub method: HttpMethod,
    /// The function called in the consul client.
    pub function: Function,
    /// The status code returned by the call if any.
    pub status: Option<StatusCode>,
    /// The duration of the call.
    pub duration: Option<Duration>,
}

#[cfg(feature = "metrics")]
impl MetricInfo {
    fn new(method: HttpMethod, function: Function, status: Option<StatusCode>) -> Self {
        Self {
            method,
            function,
            status,
            duration: None,
        }
    }

    /// Get the labels for the metric as an array of `&str`.
    pub fn labels(&self) -> [&str; 3] {
        if let Some(status) = self.status.and_then(|o| o.canonical_reason()) {
            [self.method.as_str(), self.function.as_str(), status]
        } else {
            [self.method.as_str(), self.function.as_str(), "unknown"]
        }
    }
}

#[cfg(feature = "metrics")]
#[derive(Debug, Clone)]
pub(crate) struct MetricInfoWrapper {
    metrics: MetricInfo,
    sender: Option<tokio::sync::mpsc::UnboundedSender<MetricInfo>>,
    start: std::time::Instant,
}

#[cfg(feature = "metrics")]
impl MetricInfoWrapper {
    pub fn new(
        method: HttpMethod,
        function: Function,
        status: Option<StatusCode>,
        sender: tokio::sync::mpsc::UnboundedSender<MetricInfo>,
    ) -> Self {
        Self {
            metrics: MetricInfo::new(method, function, status),
            sender: Some(sender),
            start: std::time::Instant::now(),
        }
    }

    pub fn set_status(&mut self, status: StatusCode) {
        self.metrics.status = Some(status);
    }

    pub fn emit_metrics(&mut self) {
        if let Some(sender) = self.sender.take() {
            let mut metrics = self.metrics;
            metrics.duration = Some(self.start.elapsed());
            let _ = sender.send(metrics);
        }
    }
}

#[cfg(feature = "metrics")]
impl Drop for MetricInfoWrapper {
    fn drop(&mut self) {
        self.emit_metrics();
    }
}

/// The HTTP methods supported by the consul API.
#[derive(Debug, Clone, Copy)]
pub enum HttpMethod {
    /// The OPTIONS method.
    Options,
    /// The GET method.
    Get,
    /// The POST method.
    Post,
    /// The PUT method.
    Put,
    /// The DELETE method.
    Delete,
    /// The HEAD method.
    Head,
    /// The TRACE method.
    Trace,
    /// The CONNECT method.
    Connect,
    /// The PATCH method.
    Patch,
    /// Extensions to the HTTP methods.
    Extensions,
}

impl HttpMethod {
    #[cfg(feature = "metrics")]
    fn as_str(&self) -> &'static str {
        match self {
            HttpMethod::Options => "options",
            HttpMethod::Get => "get",
            HttpMethod::Post => "post",
            HttpMethod::Put => "put",
            HttpMethod::Delete => "delete",
            HttpMethod::Head => "head",
            HttpMethod::Trace => "trace",
            HttpMethod::Connect => "connect",
            HttpMethod::Patch => "patch",
            HttpMethod::Extensions => "extensions",
        }
    }
}

#[cfg(feature = "metrics")]
impl From<http::Method> for HttpMethod {
    fn from(method: http::Method) -> Self {
        match method {
            http::Method::OPTIONS => HttpMethod::Options,
            http::Method::GET => HttpMethod::Get,
            http::Method::POST => HttpMethod::Post,
            http::Method::PUT => HttpMethod::Put,
            http::Method::DELETE => HttpMethod::Delete,
            http::Method::HEAD => HttpMethod::Head,
            http::Method::TRACE => HttpMethod::Trace,
            http::Method::CONNECT => HttpMethod::Connect,
            http::Method::PATCH => HttpMethod::Patch,
            _ => HttpMethod::Extensions,
        }
    }
}

/// The functions supported by the consul client.
#[derive(Debug, Clone, Copy)]
pub enum Function {
    /// The read_key function.
    ReadKey,
    /// The create_or_update_key function.
    CreateOrUpdateKey,
    /// The delete_key function.
    DeleteKey,
    /// The register_entity function.
    RegisterEntity,
    /// The deregister_entity function.
    DeregisterEntity,
    /// The get_service_nodes function.
    GetServiceNodes,
    /// The get_nodes function.
    GetNodes,
    /// The get_all_registered_services function.
    GetAllRegisteredServices,
    /// The get_session function.
    GetSession,
    /// The list_acl_tokens function
    GetAclTokens,
    /// The create_acl_policy function
    CreateACLPolicy,
    /// The list_acl_policies function
    GetACLPolicies,
    /// The read_acl_token function
    ReadACLPolicies,
    /// The delete_acl_token function
    DeleteACLToken,
    /// The read_acl_token function
    ReadACLToken,
    /// The delete_acl_policy function
    DeleteACLPolicy,
}

impl Function {
    /// Get the function as a string.
    #[cfg(feature = "metrics")]
    pub fn as_str(&self) -> &'static str {
        match self {
            Function::ReadKey => "read_key",
            Function::CreateOrUpdateKey => "create_or_update_key",
            Function::DeleteKey => "delete_key",
            Function::RegisterEntity => "register_entity",
            Function::DeregisterEntity => "deregister_entity",
            Function::GetServiceNodes => "get_service_nodes",
            Function::GetNodes => "get_nodes",
            Function::GetAllRegisteredServices => "get_all_registered_services",
            Function::GetSession => "get_session",
            Function::GetAclTokens => "list_acl_tokens",
            Function::CreateACLPolicy => "create_acl_policy",
            Function::GetACLPolicies => "get_acl_policies",
            Function::ReadACLPolicies => "read_acl_policies",
            Function::DeleteACLToken => "delete_acl_token",
            Function::ReadACLToken => "read_acl_token",
            Function::DeleteACLPolicy => "delete_acl_policy",
        }
    }
}