Struct SurfaceSpec 

pub struct SurfaceSpec {
    pub surface_id: String,
    pub catalog_id: String,
    pub components: Vec<Component>,
    pub data_model: Option<Value>,
    pub data_path: String,
    pub theme: Option<Value>,
    pub send_data_model: Option<bool>,
}

What a surface should look like, as the authoring layer sees it.

Fields

surface_id: String

Target surface id. Defaults to DEFAULT_SURFACE_ID.

catalog_id: String

Catalog the components are drawn from. Defaults to BASIC_CATALOG_ID.

components: Vec<Component>

The flat component adjacency list.

data_model: Option<Value>

Initial or updated data model. None sends no data operation.

data_path: String

Where the data model is written.

Defaults to /, which replaces the whole model. When updating a live surface, prefer a narrower pointer: the renderer’s two-way bindings write user input straight into this model, and replacing the root discards it.

theme: Option<Value>

Optional catalog-defined theme for createSurface.

send_data_model: Option<bool>

Ask the renderer to echo the data model back with every message.

Implementations

impl SurfaceSpec

pub fn new(surface_id: impl Into<String>) -> Self

A spec for the given surface with default catalog and no content.

pub fn with_components(self, components: Vec<Component>) -> Self

Sets the component list.

pub fn with_data_model(self, data_model: Value) -> Self

Sets the data model, written at SurfaceSpec::data_path.

pub fn with_catalog_id(self, catalog_id: impl Into<String>) -> Self

Sets the catalog id.

pub fn with_data_path(self, data_path: impl Into<String>) -> Self

Sets the pointer the data model is written at.

Trait Implementations

impl Clone for SurfaceSpec

fn clone(&self) -> SurfaceSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SurfaceSpec

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

Formats the value using the given formatter.

impl Default for SurfaceSpec

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for SurfaceSpec

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