Struct Surface 

pub struct Surface {
    pub actions: Vec<Action>,
    pub views: Vec<View>,
}

What a module declares from Module::surface.

Fields

actions: Vec<Action>

views: Vec<View>

Implementations

impl Surface

pub fn none() -> Self

A module with no UI. The default of Module::surface.

pub fn new() -> Self

pub fn action(self, action: Action) -> Self

pub fn view(self, view: View) -> Self

pub fn is_empty(&self) -> bool

true when nothing is declared.

pub fn validate(&self, module: &str, errors: &mut ConfigError)

Validates the declaration for module into errors, collecting every problem (the Harness::build convention): duplicate or malformed action names, paths not starting with /, an Admin action outside /admin/ (or a non-admin one inside it), an input schema that is not an object, and views naming unknown actions.

pub fn public(&self) -> Surface

The subset a renderer may show without the admin session: every non-admin action that is not a machine route, and every view that references only those. Signature actions (webhooks) are called by providers, never by browsers — exposing them in the public surface was part of the issue #133 confusion (a captcha widget rendered on a route no human submits).

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

Formats the value using the given formatter.

impl Default for Surface

fn default() -> Surface

Returns the “default value” for a type.

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

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Surface

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

where __S: Serializer,

Serialize this value into the given Serde serializer.