Struct Presentation 

pub struct Presentation {
    pub elements: Vec<ElementSpec>,
    pub theme: Option<Theme>,
    pub messages: BTreeMap<String, LocalizedText>,
}

How a profile presents itself on the dashboard: its custom elements and theme.

A Profile carries an optional presentation, so a deployment’s dashboard offers exactly the sensor types its profiles introduce and renders them the way the profile intends. The dashboard turns these declarations into the catalog it serves to the page.

Fields

elements: Vec<ElementSpec>

The custom sensors and node stats this profile contributes.

theme: Option<Theme>

An optional theme that tints the dashboard.

messages: BTreeMap<String, LocalizedText>

Localized text for the stable codes this profile introduces, keyed by the page’s message key (a discrete state such as "state.flushing" or an event such as "event.filter_clog"). The dashboard ships no translation for a code it never knew, so a profile that emits a custom state or event supplies its wording here.

Implementations

impl Presentation

pub fn new() -> Presentation

Starts an empty presentation.

Returns

A presentation with no elements and no theme.

pub fn with_element(self, element: ElementSpec) -> Presentation

Adds a custom element.

Arguments

• element - the sensor or stat to contribute.

Returns

The presentation, for chaining.

pub fn with_theme(self, theme: Theme) -> Presentation

Sets the theme that tints the dashboard.

Arguments

• theme - the theme tokens to apply.

Returns

The presentation, for chaining.

pub fn with_message( self, key: impl Into<String>, text: impl Into<LocalizedText>, ) -> Presentation

Supplies localized text for a stable code this profile introduces.

Use this for a custom discrete state or event the dashboard ships no wording for, so the page renders it as words rather than the raw code.

Arguments

• key - the page message key, such as "state.flushing" or "event.filter_clog".
• text - the text, one string for every locale or a per-locale map.

Returns

The presentation, for chaining.

Trait Implementations

impl Clone for Presentation

fn clone(&self) -> Presentation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Presentation

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

Formats the value using the given formatter.

impl Default for Presentation

fn default() -> Presentation

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Presentation

fn deserialize<__D>( __deserializer: __D, ) -> Result<Presentation, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Presentation

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

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 Presentation