Enum DashboardItem 

pub enum DashboardItem {
    Stat {
        query_id: String,
        label: Option<String>,
        unit: Option<String>,
    },
    TimeSeries {
        query_id: String,
        label: Option<String>,
        unit: Option<String>,
        preferred_bucket_seconds: Option<u64>,
    },
    Table {
        query_id: String,
        label: Option<String>,
        unit: Option<String>,
    },
    HealthSummary {
        label: Option<String>,
    },
    Links {
        links: Vec<DashboardLink>,
    },
}

One dashboard item: a typed presentation declaration. The wire form is internally tagged on kind (snake_case), pinned key-for-key by the manifest payload serialization test.

Variants

Stat

Fields

query_id: String

label: Option<String>

unit: Option<String>

TimeSeries

Fields

query_id: String

label: Option<String>

unit: Option<String>

preferred_bucket_seconds: Option<u64>

Table

Fields

query_id: String

label: Option<String>

unit: Option<String>

HealthSummary

Fields

label: Option<String>

Links

Fields

links: Vec<DashboardLink>

Implementations

impl DashboardItem

pub fn stat(query_id: impl Into<String>) -> DashboardItem

A single-value item rendering a scalar named metric. Infallible: a query_id is an opaque reference to a same-manifest metric; the server rejects unknown ones at ingest.

pub fn time_series(query_id: impl Into<String>) -> DashboardItem

A chart item rendering a time_series named metric. Infallible: see DashboardItem::stat.

pub fn table(query_id: impl Into<String>) -> DashboardItem

A table item rendering a table named metric. Infallible: see DashboardItem::stat.

pub fn health_summary() -> DashboardItem

Renders the app’s durable run-health state; carries no query.

pub fn links(links: Vec<DashboardLink>) -> DashboardItem

A navigation link list; carries no query.

pub fn label(self, label: impl Into<String>) -> DashboardItem

Infallible: sets the display label, overriding the referenced metric’s display_name. The server enforces the 256-char cap at ingestion. No documented no-op case: every item kind carries a label.

pub fn unit(self, unit: impl Into<String>) -> DashboardItem

Infallible: sets the display unit, overriding the referenced metric’s unit. When the referenced metric declares a unit, the server requires exact equality at ingest; over a unit-less metric any valid unit text is allowed. The builder does not duplicate that check. Documented no-op on health_summary and links, which carry no unit field — returns self unchanged.

pub fn preferred_bucket_seconds(self, seconds: u64) -> DashboardItem

Infallible: bucket-width guidance for callers of the execute endpoint (which already accepts bucket_seconds); the server never rewrites queries for it. Documented no-op on every kind except time_series — returns self unchanged.

Trait Implementations

impl Clone for DashboardItem

fn clone(&self) -> DashboardItem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DashboardItem

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

Formats the value using the given formatter.

impl Eq for DashboardItem

impl PartialEq for DashboardItem

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for DashboardItem

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for DashboardItem