Struct Cms 

pub struct Cms { /* private fields */ }

A small content store with an editor.

Implementations

impl Cms

pub fn new() -> Self

A CMS that, until Cms::collections or Cms::any_collection says otherwise, allows no collection — so a misconfigured venture refuses content rather than accepting anything.

pub fn collections( self, collections: impl IntoIterator<Item = impl Into<String>>, ) -> Self

Exactly these collection slugs may hold content.

pub fn any_collection(self) -> Self

Accept any collection slug.

Trait Implementations

impl Default for Cms

fn default() -> Self

Returns the “default value” for a type.

impl Module for Cms

fn personal_data(&self) -> &'static [PersonalDataSet]

Both tables hold the venture’s own published content and neither has a column that names a person (issue #265).

Declared rather than left silent: an export that skipped these tables and an export that had never heard of them look identical from the outside, and only one of them is a decision. The reason below is what GET /v1/privacy/manifest publishes, so it is written for the person reading it.

A row is filed under a collection and a slug. What an editor types into body or data is the venture’s to govern — this module cannot know that an article mentions somebody — but the shape of the table offers erasure nothing to match on, and inventing a subject column here would be inventing a promise. That gap is the one issue #266 describes for Outbox, and it is the same gap for the same reason.

fn name(&self) -> &'static str

Kebab-case name; mounted at /v1/<name>.

fn version(&self) -> &'static str

env!("CARGO_PKG_VERSION"), surfaced by /__health.

fn requires(&self) -> &'static [Port]

Ports the module cannot run without; missing = build error.

fn tables(&self) -> &'static [&'static str]

Table names this module owns; duplicates across modules are a build error.

fn migrations(&self) -> Migrations

The module’s migrations, embedded per dialect.

fn validate_config(&self, cfg: &dyn Config) -> Result<(), ConfigError>

Rejects invalid configuration: missing required keys or malformed values, reported together with the module name.

fn router(&self, ctx: ModuleContext) -> Router

The module’s router, nested under /v1/<name>.

fn surface(&self) -> Surface

The module’s UI surface (ADR 0010): the actions a renderer may offer and the views that compose them. Input schemas come from the handler’s own body types (Action::input::<Body>()), so the declaration cannot drift from the route. Harness::build validates it; GET /__surface serves the composition. Default: nothing, and a module that declares nothing renders nothing.

fn harness_api(&self) -> u32

Contract version, checked by Harness::build.

fn optional(&self) -> &'static [Port]

Ports the module uses when present.

fn depends_on(&self) -> &'static [&'static str]

Modules this one’s schema sits on top of, by name.

fn emits(&self) -> &'static [&'static str]

Event names this module emits ("<module>.<event>"), listed by /__health.

fn public_writes(&self) -> bool

Whether the module has public write endpoints.

fn public_write_policy(&self) -> RoutePolicy

What actually protects those public writes, for a module with no ADR 0010 surface to hang a per-action RoutePolicy on (issue #143).

fn signature_verification(&self) -> SignatureVerification

Which verifier proves this module’s RoutePolicy::Signature deliveries (issue #533): how a webhook handler checks a machine signature before acting.

fn max_body_bytes(&self, _cfg: &dyn Config) -> usize

The largest request body any route of this module accepts, so a runtime can refuse an oversize body before buffering it (issue #440).

fn streaming_routes(&self) -> &'static [StreamRoute]

Routes this module serves in streaming mode (issue #585), each with its own StreamRoute::max_bytes ceiling. Opt-in: the default is empty, and every existing route keeps the buffered behaviour it always had.

fn self_check(&self) -> Vec<String>

Problems the module can find in itself, with no configuration and no environment: its own embedded data, checked against its own declarations.

fn well_known(&self) -> Option<Router>

Routes this module serves at the root under /.well-known, for spec-mandated discovery documents (OIDC openid-configuration, jwks.json) that must live outside /v1 (issue #46). Paths are relative to the prefix: register /jwks.json, not /.well-known/jwks.json.

fn events( &self, ) -> Vec<(String, Arc<dyn Fn(&Scope, Value) -> Pin<Box<dyn Future<Output = Result<(), Box<dyn Error + Sync + Send>>> + Send>> + Sync + Send>)>

Handlers for events other modules emit; registered at Harness::build.

fn scheduled<'a>( &'a self, ctx: &'a ModuleContext, cron: &'a str, ) -> Pin<Box<dyn Future<Output = Result<(), Box<dyn Error + Sync + Send>>> + Send + 'a>>

Scheduled work (cron is the trigger expression). Default: none.