Struct HealthStatus 

#[non_exhaustive]
pub struct HealthStatus {
    pub(crate) ready: bool,
    pub(crate) reason: String,
}

Reports whether a plugin is ready to accept tasks.

Constructed via HealthStatus::ready or HealthStatus::not_ready. The daemon polls this periodically and will not dispatch tasks to a plugin that reports not-ready.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

ready: bool

reason: String

Implementations

impl HealthStatus

pub fn ready() -> Self

Create a status indicating the plugin is ready to accept tasks.

pub fn not_ready(reason: impl Into<String>) -> Self

Create a status indicating the plugin is not ready, with a reason.

pub fn is_ready(&self) -> bool

Return whether the plugin is ready to accept tasks.

pub fn reason(&self) -> &str

Return the reason string (empty if ready).

Trait Implementations

impl Clone for HealthStatus

fn clone(&self) -> HealthStatus

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for HealthStatus

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for HealthStatus

fn eq(&self, other: &HealthStatus) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for HealthStatus