HealthServer

Struct HealthServer 

Source
pub struct HealthServer<H>
where H: HealthCheck + 'static,
{ /* private fields */ }
Expand description

HTTP health check server

Exposes /health and /ready endpoints for health monitoring.

Implementations§

Source§

impl<H> HealthServer<H>
where H: HealthCheck + 'static,

Source

pub fn new(health: H) -> HealthServer<H>

Create a new health server

Source

pub fn addr(self, addr: impl Into<SocketAddr>) -> HealthServer<H>

Set the address to bind to

Source

pub fn port(self, port: u16) -> HealthServer<H>

Set the port (binds to 0.0.0.0)

Source

pub async fn serve(self) -> Result<(), HealthServerError>

Start the health server

This will block until the server is shut down.

Source

pub async fn serve_with_shutdown<F>( self, shutdown: F, ) -> Result<(), HealthServerError>
where F: Future<Output = ()> + Send,

Start the health server with graceful shutdown

Source

pub fn check(&self) -> Pin<Box<dyn Future<Output = HealthReport> + Send + '_>>

Get a health report without starting the server

Auto Trait Implementations§

§

impl<H> Freeze for HealthServer<H>

§

impl<H> RefUnwindSafe for HealthServer<H>
where H: RefUnwindSafe,

§

impl<H> Send for HealthServer<H>

§

impl<H> Sync for HealthServer<H>

§

impl<H> Unpin for HealthServer<H>

§

impl<H> UnwindSafe for HealthServer<H>
where H: RefUnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more