68 lines
2.1 KiB
Rust
68 lines
2.1 KiB
Rust
//! A `tonic` based gRPC healthcheck implementation.
|
|
//!
|
|
//! # Example
|
|
//!
|
|
//! An example can be found [here].
|
|
//!
|
|
//! [here]: https://github.com/hyperium/tonic/blob/master/examples/src/health/server.rs
|
|
|
|
#![warn(
|
|
missing_debug_implementations,
|
|
missing_docs,
|
|
rust_2018_idioms,
|
|
unreachable_pub
|
|
)]
|
|
#![doc(
|
|
html_logo_url = "https://raw.githubusercontent.com/tokio-rs/website/master/public/img/icons/tonic.svg"
|
|
)]
|
|
#![deny(broken_intra_doc_links)]
|
|
#![doc(html_root_url = "https://docs.rs/tonic-health/0.4.1")]
|
|
#![doc(issue_tracker_base_url = "https://github.com/hyperium/tonic/issues/")]
|
|
#![doc(test(no_crate_inject, attr(deny(rust_2018_idioms))))]
|
|
#![cfg_attr(docsrs, feature(doc_cfg))]
|
|
|
|
use std::fmt::{Display, Formatter};
|
|
|
|
/// Generated protobuf types from the `grpc.healthy.v1` package.
|
|
pub mod proto {
|
|
#![allow(unreachable_pub)]
|
|
#![allow(missing_docs)]
|
|
tonic::include_proto!("grpc.health.v1");
|
|
|
|
pub const GRPC_HEALTH_V1_FILE_DESCRIPTOR_SET: &'static [u8] =
|
|
tonic::include_file_descriptor_set!("grpc_health_v1");
|
|
}
|
|
|
|
pub mod server;
|
|
|
|
/// An enumeration of values representing gRPC service health.
|
|
#[derive(Copy, Clone, Debug, PartialEq)]
|
|
pub enum ServingStatus {
|
|
/// Unknown status
|
|
Unknown,
|
|
/// The service is currently up and serving requests.
|
|
Serving,
|
|
/// The service is currently down and not serving requests.
|
|
NotServing,
|
|
}
|
|
|
|
impl Display for ServingStatus {
|
|
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
|
|
match self {
|
|
ServingStatus::Unknown => f.write_str("Unknown"),
|
|
ServingStatus::Serving => f.write_str("Serving"),
|
|
ServingStatus::NotServing => f.write_str("NotServing"),
|
|
}
|
|
}
|
|
}
|
|
|
|
impl From<ServingStatus> for proto::health_check_response::ServingStatus {
|
|
fn from(s: ServingStatus) -> Self {
|
|
match s {
|
|
ServingStatus::Unknown => proto::health_check_response::ServingStatus::Unknown,
|
|
ServingStatus::Serving => proto::health_check_response::ServingStatus::Serving,
|
|
ServingStatus::NotServing => proto::health_check_response::ServingStatus::NotServing,
|
|
}
|
|
}
|
|
}
|