Skip to main content

Module check

Module check 

Source
Expand description

Preflight check types for faucet doctor (#126).

A connector’s check() returns a CheckReport of Probes. Probe-level failures are ProbeStatus::Fail inside an Ok(report); an Err from check() means “couldn’t run any probe” and is rendered as a single failure.

Structs§

CheckContext
Inputs a probe may need. The doctor command enforces timeout on the whole check() call; connectors may also use it to bound their own client calls.
CheckReport
A connector’s full preflight report.
Probe
One named probe within a CheckReport (e.g. "read", "auth", "network", "permissions", "schema", "io", "sentinel").

Enums§

ProbeStatus
Outcome of a single probe.