Expand description
The app model (principle 8): read once from source and shared by every generator and check so they cannot disagree.
Re-exports§
pub use naming::KnownArea;pub use naming::WiringSide;
Modules§
- naming
- One function per name, so the generator and the checks cannot disagree.
- permissions
- syntax
- testing
- Test helpers panic: a broken fixture is a broken test.
- usage
- Names are matched without resolving paths: the dead code check can miss dead code but never calls live code dead.
Structs§
- Aggregate
- App
- Area
Contribution - Area
Definition - Call
- Code
- Config
Key - Contract
Method - Contract
Trait sofie splitserves it from the app its module moves to.- Crate
- Cross
Owner Check - A call of an aggregate’s crate-private
across, which reads past the owner filter. - Dependency
- Effects
- Entitlement
Declaration const EXPORT: Entitlement = Entitlement::new("project.export");, or aLimitorQuota.- Entitlements
- What the app’s modules declare a plan may hold.
- Enum
Declaration - Enum
Variant - Event
Declaration - Feature
Code - Feature
Declaration - Feature
Gate - Field
Declaration - Function
- Gateway
- Gateway
Adapter - Identity
- Input
Declaration - Island
- Island
Bundle - Job
- KeyLiteral
- A translation key Rust code names as a literal, which the source language must have.
- Listed
Route - A row of a package’s
ROUTEStable, kept when its features are on. - Listener
- Macro
Call - Mail
Template src/mails/<name>.html, keyed<module>/<name>; one undersrc/mails/<crate>/is keyed<crate>/<name>, replacing that crate’s own mail.- Manifest
- Menu
Entry - Menu
File - Method
Call - Model
Error - Module
- Module
Config - Mounted
Screen - A shipped screen in the area the app mounts its routes in, under the key it renders as.
- Package
Routes - The framework packages’ routes where the app’s areas serve them.
- Path
Reference - Private
Item - A
modor a wired function that is notpub: the wiring cannot name it or what is below it. - Product
Event product_event!(order.placed, order.total): its name and the values it records, as written.- Props
Declaration - Provision
- Queued
- Raised
- RawSql
- Read
Model - Remote
Module - A module split into another app, known here only through its contract.
- Route
- Route
Mount - A package’s route function mounted in one of the app’s areas.
- Routed
Package - A framework package whose routes the app mounts in its areas.
- Schedule
- Screen
Override - Screen
Render - Screen
Route - A package route rendering one of its
src/screenstemplates:.screen(path, name, handler).name("…")or.name_for::<A>("…"). - Served
Route - A package’s route where the app serves it.
- Shipped
Screen - A screen a sofie-identity route renders from a template file of its own:
.shipped(path, name, (include_str!(file), describe), loader).name(handler). - Sign
InPaths - Source
- Split
- What
sofie splitwrote into the app’s[package.metadata.sofie]. - Task
- Named
<module>.<function>wherever undertasksit lives. - Telemetry
Code - Type
Method - Type
Name - Wall
Clock
Enums§
- Area
Client - What an area’s pages are: HTML over the wire, or a client framework’s components compiled from the same templates.
- Cadence
- Written as
every 1h,daily at 03:00 Europe/Istanbulorweekly on monday at 03:00 Europe/Istanbul. - KeyKind
- Method
- Modifier
- Module
Declaration - Then
- Tier
- Ordered lowest first, so a module may depend on any tier
<=its own.
Constants§
Functions§
- check_
route_ path - What the router would refuse only at boot, refused before the build. What the router serves and a browser can request; the CLI writes no route this refuses.
- config_
type_ name - dependency_
crate - files_
with_ extension - framework_
features - Resolving them reads the whole dependency graph, so they are read only when asked.
- interval_
seconds - is_
island_ name - Must match sofie-engine’s
is_island_name, which refuses the island at boot; sofie-check’s tests compare the two. - island_
bundles - A module’s
web/islands belong to every area a module routes in. - load
- manifest_
file - module_
declaration - rust_
files - subdirectories
- workspace_
crates - workspace_
root