Struct DashboardCard 

pub struct DashboardCard {
    pub id: String,
    pub title: String,
    pub value: Value,
    pub status: HealthStatus,
    pub detail: String,
    pub source: DashboardSource,
    pub route: String,
    pub action: Option<String>,
}

One fact on a dashboard: a value read out of one capability’s answer, the verdict the source gives it, where a reader drills in, and what acts on it.

use majordomus_cli::capability::builtin::dashboard::DashboardCard;
use serde_json::json;

let card: DashboardCard = serde_json::from_value(json!({
    "id": "health-status",
    "title": "Health",
    "value": "ok",
    "status": "ok",
    "detail": "the worst of 8 check(s)",
    "source": { "capability": "health.report", "input": {}, "pointer": "/status", "measure": "exact" },
    "route": "/cockpit/health",
})).unwrap();
// the value is the source's: reading the pointer out of its answer gives it back
assert_eq!(card.source.measure.read(&json!({ "status": "ok" }), &card.source.pointer), card.value);
assert!(card.action.is_none());

Fields

id: String

A stable id, [a-z][a-z0-9-]*, unique across the dashboard.

title: String

What the value is.

value: Value

The value, read out of the source’s answer by the source’s measure: a number, a string or a boolean, or null when the source holds none.

status: HealthStatus

The source’s verdict on it; unknown when the source could not answer.

detail: String

One line: what the value means, or why the source could not answer.

source: DashboardSource

Where the value came from.

route: String

The Cockpit page a reader drills into for the evidence.

action: Option<String>

The command that acts on it, when one does.

Trait Implementations

impl Clone for DashboardCard

fn clone(&self) -> DashboardCard

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DashboardCard

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DashboardCard

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for DashboardCard

impl JsonSchema for DashboardCard

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for DashboardCard

fn eq(&self, other: &DashboardCard) -> 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 Serialize for DashboardCard

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for DashboardCard