Struct Catalog 

pub struct Catalog { /* private fields */ }

The presentation catalog served at GET /catalog.

Build one from the profiles a deployment runs with from_profiles, or from presentations directly with from_presentations. The page fetches it on boot, appends its custom presets to the built-in ones, applies the theme, and places groups on its network map where with_site_position says. A gateway with no custom elements need not serve a catalog at all; the page then keeps its defaults.

Implementations

impl Catalog

pub fn from_profiles(profiles: &[&Profile]) -> Self

Builds a catalog from the presentation of each profile a deployment runs.

Every ElementSpec across the profiles becomes one preset, keyed and de-duplicated by its element key (the first wins). The theme is the first one a profile declares.

Arguments

• profiles - the profiles whose presentation to gather.

Returns

A catalog carrying the custom presets and theme.

pub fn from_presentations(presentations: &[&Presentation]) -> Self

Builds a catalog from presentations, for a deployment that declares its elements without a profile.

The de-duplication and theme rules are those of from_profiles.

Arguments

• presentations - the presentations whose elements to gather.

Returns

A catalog carrying the custom presets and theme.

pub fn with_site_position( self, group: impl Into<String>, x: f32, y: f32, ) -> Self

Places a group on the page’s network map.

Arguments

• group - the group’s id, or __gateway for the gateway itself.
• x - the position across the map, 0.0 at the left edge to 1.0 at the right.
• y - the position down the map, 0.0 at the top to 1.0 at the bottom.

Returns

The catalog, for chaining.

pub fn is_empty(&self) -> bool

Whether the catalog carries nothing the page does not already have.

Returns

true when there are no custom presets, theme, messages, or map positions, so a gateway can skip serving it.

pub fn to_json(&self) -> Result<String, Error>

Serializes the catalog to the JSON served at GET /catalog.

Returns

The JSON text of the catalog.

Errors

Returns a serde_json::Error if the catalog cannot be serialized, which in practice only happens on a non-finite band value.

Trait Implementations

impl Clone for Catalog

fn clone(&self) -> Catalog

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Catalog

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

Formats the value using the given formatter.

impl Serialize for Catalog

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

where __S: Serializer,

Serialize this value into the given Serde serializer.