pub struct DoctorCheck {
pub category: &'static str,
pub name: String,
pub ok: bool,
pub value: Option<String>,
pub hint: Option<String>,
pub latency_ms: Option<u64>,
}Expand description
A single pre-flight check result.
ok = true → the check passed; value shows what was found.
ok = false → the check failed; hint explains how to fix it.
§CUSTOMIZE
Serialises directly to the --json output. Add fields here if you need
additional metadata (e.g. severity: "warning" | "error", doc_url).
Fields§
§category: &'static strLogical category for grouping in human output and JSON filtering.
CUSTOMIZE: Defined by each check_* function. Categories in Soma:
“config” | “credentials” | “connectivity” | “server” | “auth”
name: StringShort human-readable name for the check (shown in the left column).
ok: booltrue = passed (✓), false = failed (✗).
value: Option<String>What was found — shown in the right column when ok=true. For failed checks, the hint is more useful.
hint: Option<String>How to fix the problem — only present when ok = false.
CUSTOMIZE: Make hints actionable — tell the user exactly what to type.
latency_ms: Option<u64>Round-trip latency in milliseconds — only for connectivity checks.
Trait Implementations§
Source§impl Debug for DoctorCheck
impl Debug for DoctorCheck
Auto Trait Implementations§
impl Freeze for DoctorCheck
impl RefUnwindSafe for DoctorCheck
impl Send for DoctorCheck
impl Sync for DoctorCheck
impl Unpin for DoctorCheck
impl UnsafeUnpin for DoctorCheck
impl UnwindSafe for DoctorCheck
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
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§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>
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>
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 more