Struct SurfaceDocument 

pub struct SurfaceDocument {
    pub surface_api: u32,
    pub harness_api: u32,
    pub venture: VentureSurface,
    pub modules: Vec<ModuleSurface>,
    pub ui: Option<Value>,
}

The document GET /__surface serves: composed at Harness::build, one entry per module in mount order, modules with an empty surface omitted.

Fields

surface_api: u32

harness_api: u32

venture: VentureSurface

modules: Vec<ModuleSurface>

ui: Option<Value>

The mounted renderer’s build-time configuration (UiMount::describe).

Implementations

impl SurfaceDocument

pub fn compose(venture: &Venture, modules: &[Arc<dyn Module>]) -> Self

Composes the full document (admin actions included).

pub fn public(&self) -> Self

The public subset: admin actions and the views over them removed, modules left with nothing omitted.

Trait Implementations

impl Clone for SurfaceDocument

fn clone(&self) -> SurfaceDocument

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SurfaceDocument

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SurfaceDocument

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SurfaceDocument

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

where __S: Serializer,

Serialize this value into the given Serde serializer.