Skip to main content

HealthCheckBuilder

Struct HealthCheckBuilder 

Source
pub struct HealthCheckBuilder<CT, ST> { /* private fields */ }
Expand description

Typestate builder for HealthCheck.

Type parameters track whether required fields have been set:

  • CTString once .component_type() is called, () otherwise
  • STHealthStatus once .status() is called, () otherwise

HealthCheckBuilder::build is only available when both are set.

Requires std or alloc.

Implementations§

Source§

impl<ST> HealthCheckBuilder<(), ST>

Source

pub fn component_type( self, component_type: impl Into<String>, ) -> HealthCheckBuilder<String, ST>

Set the component type, e.g. "datastore", "component", "system".

Source§

impl<CT> HealthCheckBuilder<CT, ()>

Source

pub fn status( self, status: HealthStatus, ) -> HealthCheckBuilder<CT, HealthStatus>

Set the check result status.

Source§

impl<CT, ST> HealthCheckBuilder<CT, ST>

Source

pub fn output(self, output: impl Into<String>) -> Self

Set a human-readable output or error message.

Source

pub fn time(self, time: impl Into<String>) -> Self

Set an RFC 3339 timestamp of when this check was performed.

Source§

impl HealthCheckBuilder<String, HealthStatus>

Source

pub fn build(self) -> HealthCheck

Build the HealthCheck.

Only available once both component_type and status have been set.

Auto Trait Implementations§

§

impl<CT, ST> Freeze for HealthCheckBuilder<CT, ST>
where CT: Freeze, ST: Freeze,

§

impl<CT, ST> RefUnwindSafe for HealthCheckBuilder<CT, ST>

§

impl<CT, ST> Send for HealthCheckBuilder<CT, ST>
where CT: Send, ST: Send,

§

impl<CT, ST> Sync for HealthCheckBuilder<CT, ST>
where CT: Sync, ST: Sync,

§

impl<CT, ST> Unpin for HealthCheckBuilder<CT, ST>
where CT: Unpin, ST: Unpin,

§

impl<CT, ST> UnsafeUnpin for HealthCheckBuilder<CT, ST>
where CT: UnsafeUnpin, ST: UnsafeUnpin,

§

impl<CT, ST> UnwindSafe for HealthCheckBuilder<CT, ST>
where CT: UnwindSafe, ST: UnwindSafe,

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, 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.