Struct Surface 

pub struct Surface {
    pub kind: String,
    pub label: String,
    pub version: u32,
    pub person: bool,
    pub verbs: Vec<VerbSurface>,
    pub fields: Vec<FieldSurface>,
    pub types: Vec<NamedType>,
}

The public surface of one resource kind. See the module docs.

Fields

kind: String

label: String

version: u32

The storage version (#[resource(version = N)]).

person: bool

A record of the person’s own, kept in their store rather than the workspace of the window showing it: one the app declares with itself (its ResourceApp::PERSON_RECORDS). Only the kinds an app’s surface marks so may it keep in, or read from, the person’s store.

verbs: Vec<VerbSurface>

Absent from a surface file that lists none.

fields: Vec<FieldSurface>

Every stored field, depth first; empty for a resource without a model shape.

types: Vec<NamedType>

The records and enums its fields’ types name (FieldType::Named), each declared once, by name.

Implementations

impl Surface

What a receiver without the app reads from its surface: each verb’s kind and tree field, which paths offer field edits, and which storage units an action may write (* for any item).

pub fn named(&self, name: &str) -> Option<&NamedType>

The named type name of Self::types.

pub fn verb(&self, action: &str) -> Option<(ActionKind, Option<String>)>

The kind of the verb action and the field it sits under, or None when the app publishes no such verb.

pub fn editable(&self, path: &[PathStep]) -> bool

Whether the field at path offers edits: stored, and neither it nor a field above it read-only. Reactions are the exception: their only edits record who invoked them, so they forge nothing a read-only field protects, and the record refuses any other edit of them.

pub fn edit_unit(&self, path: &[PathStep]) -> Vec<PathStep>

The storage unit a field edit at path writes: the field’s unit, an item of a unit collection, else the record (the empty path).

pub fn footprint(&self, action: &str, item: Option<&str>) -> Vec<Vec<PathStep>>

The units the verb action may write, on the item item when it acts on one: the record (the empty path), its item’s unit, and the units of the fields it declares, * standing for any item.

Trait Implementations

impl Clone for Surface

fn clone(&self) -> Surface

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Surface

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Surface

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Surface

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

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 Surface