pub struct HealthReporter { /* private fields */ }Expand description
A handle providing methods to update the health status of gRPC services. A
HealthReporter is connected to a HealthServer which serves the statuses
over the grpc.health.v1.Health service.
Implementations§
Source§impl HealthReporter
impl HealthReporter
Sourcepub fn new() -> HealthReporter
pub fn new() -> HealthReporter
Create a new HealthReporter with an initial service (named “”), corresponding to overall server health
Sourcepub async fn set_serving<S>(&self)where
S: NamedService,
pub async fn set_serving<S>(&self)where
S: NamedService,
Sets the status of the service implemented by S to Serving. This notifies any watchers
if there is a change in status.
Sourcepub async fn set_not_serving<S>(&self)where
S: NamedService,
pub async fn set_not_serving<S>(&self)where
S: NamedService,
Sets the status of the service implemented by S to NotServing. This notifies any watchers
if there is a change in status.
Sourcepub async fn set_service_status<S>(
&self,
service_name: S,
status: ServingStatus,
)
pub async fn set_service_status<S>( &self, service_name: S, status: ServingStatus, )
Sets the status of the service with service_name to status. This notifies any watchers
if there is a change in status.
Sourcepub async fn clear_service_status(&mut self, service_name: &str)
pub async fn clear_service_status(&mut self, service_name: &str)
Clear the status of the given service.
Trait Implementations§
Source§impl Clone for HealthReporter
impl Clone for HealthReporter
Source§fn clone(&self) -> HealthReporter
fn clone(&self) -> HealthReporter
Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl Debug for HealthReporter
impl Debug for HealthReporter
Source§impl Default for HealthReporter
impl Default for HealthReporter
Source§fn default() -> HealthReporter
fn default() -> HealthReporter
Returns the “default value” for a type. Read more
Auto Trait Implementations§
impl !RefUnwindSafe for HealthReporter
impl !UnwindSafe for HealthReporter
impl Freeze for HealthReporter
impl Send for HealthReporter
impl Sync for HealthReporter
impl Unpin for HealthReporter
impl UnsafeUnpin for HealthReporter
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
Source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
Wrap the input message
T in a tonic::Request