Struct ModuleManifest 

#[non_exhaustive]
pub struct ModuleManifest {
    pub name: String,
    pub story_display: Vec<StoryDisplayDescriptor>,
    pub admin: Option<AdminSurface>,
    pub http_routes: Vec<ModuleHttpRoute>,
    pub runtime: Option<RuntimeSurface>,
    pub events: Option<EventSurface>,
    pub lifecycle: Option<LifecycleSurface>,
    pub console: Vec<ConsoleSurface>,
    pub console_slots: Vec<ConsoleSlot>,
    pub console_contributions: Vec<ConsoleContribution>,
    pub capabilities: Vec<String>,
    pub dependencies: Vec<String>,
}

The serializable metadata a module exposes. Runtime config is deliberately NOT here — it stays an internal &'static field on [crate::Module] because the config registry needs the real (non-serde) RuntimeConfigType to validate. Only round-trippable fields belong here.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

Stable module name, e.g. "identity".

story_display: Vec<StoryDisplayDescriptor>

Console story-display metadata.

admin: Option<AdminSurface>

Admin surface: Some(AdminSurface::Schema(_)) for schema-driven CRUD, future custom surfaces for richer module admin UI, or None for modules with no admin surface (e.g. notifications).

http_routes: Vec<ModuleHttpRoute>

Declared module-owned HTTP routes. These are metadata only until a loading-source-specific mount/proxy protocol exists.

runtime: Option<RuntimeSurface>

Declared runtime behavior. These entries are manifest data only; source bindings decide how to register executable behavior.

events: Option<EventSurface>

Declared event subscriptions. These entries are manifest data only; source bindings decide how to register executable behavior.

lifecycle: Option<LifecycleSurface>

Declared lifecycle work. The host validates and schedules these entries; modules do not receive arbitrary startup callbacks.

console: Vec<ConsoleSurface>

Declared Runtime Console surfaces provided by trusted frontend packages.

console_slots: Vec<ConsoleSlot>

Declared Runtime Console extension slots owned by host or module surfaces.

console_contributions: Vec<ConsoleContribution>

Declared Runtime Console slot contributions attached to host or module-owned surfaces.

capabilities: Vec<String>

RESERVED SEAM — capabilities the module declares (perms/tenancy).

dependencies: Vec<String>

Other modules this module requires to be installed first.

Implementations

impl ModuleManifest

pub fn builder(name: impl Into<String>) -> ModuleManifestBuilder

Start building a manifest for name.

Trait Implementations

impl Clone for ModuleManifest

fn clone(&self) -> ModuleManifest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ModuleManifest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ModuleManifest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ModuleManifest

impl PartialEq for ModuleManifest

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ModuleManifest