Structs§
- Capability
Set - Controller
Query Id - Controller
SseTopic Id - Data
Source Descriptor - Data
Source Empty State - Data
Source Filtering - Data
Source Id - Data
Source Pagination - Data
Source Sorting - Effective
Tenant Binding - Encrypted
Sensitive Params - Form
Field Descriptor - Form
Select Option - Form
UiDescriptor - Form
Visible When - Framework
Generation - Framework
Generation Range - Interaction
Confirmation - Interaction
Descriptor - Interaction
Id - Param
Field Descriptor - Opt-in per-field parameter declaration on an interaction. Declared fields get strict typed parsing on GET query strings and per-field body validation on mutating methods; undeclared keys pass through untyped.
- Parse
Interaction Http Method Error - Error returned by the strict
std::str::FromStrimpl. - Parse
Provider Encryption Algorithm Error - Error returned by the strict
std::str::FromStrimpl. - Provider
Encryption Metadata - Provider
Identity - Registered
Surface - Surface
Action Cancel - Surface
Action Error - Surface
Action Request - Surface
Action Response - Surface
Context Selector Descriptor - Describes a context-selector dropdown rendered above a surface’s content.
- Surface
Descriptor - Surface
Descriptor Builder - Builder for
SurfaceDescriptor. - Surface
Entity Ref - Cell value for entity-link columns.
- Surface
Id - Surface
Registration - Surface
Registration Error - Surface
Registration Policy - Surface
RowVisible When - Surface
Slot Def - Surface
Tab - Surface
TabId - Surface
Table Column - Surface
Table RowAction - Workflow
Step Descriptor
Enums§
- Action
Ref - Reference to an interaction from an action bar. Untagged two-form reader: the legacy bare-string form (method omitted — resolves only when the target ID registers exactly one method) and an object form for multi-method IDs. NOTE: adding a third form later hard-fails two-form readers on old peers (accepted, spec §2a).
- Caller
Origin - Callout
Level - Capability
- Confirmation
Severity - Data
Source Kind - Data
Source Validation Error - Form
Select Source - Icon
Name Error - Errors reported by
validate_icon_name. - Identifier
Error - Interaction
Http Method - HTTP method a surface interaction is dispatched with (REST method model, B1).
- Interaction
Kind - Interaction
Transport - Interaction
Validation Error - Provider
Encryption Algorithm - Encryption algorithm used for ECIES sealed-box parameter encryption.
- Provider
Kind - Refresh
Policy - Schema
Contract - Scope
- Slot
Validation Error - Surface
Action Cancel Reason - Surface
Action Error Code - Surface
Entity Type - Wire-safe entity type enum.
- Surface
Node - Surface
Registration Error Code - Surface
RowCondition - Surface
Table Cell Type - Cell type for a surface table column.
- Targeting
Constants§
- KNOWN_
INTERACTION_ HTTP_ METHODS - Known variants for exhaustive test iteration (mirrors the
ProviderEncryptionAlgorithmprecedent inprotocol.rs). - MAX_
ICON_ NAME_ LEN - Maximum length (in bytes) of a Lucide-canonical icon name.
- MAX_
IDENTIFIER_ LEN - MAX_
INTERACTION_ TIMEOUT_ SECONDS - MIN_
INTERACTION_ TIMEOUT_ SECONDS - MIN_
PROVIDER_ REFRESH_ INTERVAL_ SECONDS - RESERVED_
PARAM_ KEYS - Framework-reserved / envelope query keys. Provider-declared
paramskeys must not collide with these (admission rule, spec §4 rule 1).idis the B5 item-addressing key populated from the/{item_id}path segment. - SLOT_
HOST_ DETAIL_ TABS - SLOT_
SETTINGS_ BELOW_ GLOBAL - SLOT_
SETTINGS_ TABS - SLOT_
SOFTWARE_ ITEM_ HOST_ CONTEXT_ MENU - SLOT_
SOFTWARE_ ITEM_ TABS - SLOT_
SOFTWARE_ TABS - SLOT_
SURFACE_ PAGE
Functions§
- all_
surface_ slots - is_
valid_ surface_ identifier - slot_
def - validate_
icon_ name - Validates a candidate Lucide icon name.
- validate_
slot_ id - Validates a surface slot identifier and resolves its registered slot definition.
- validate_
surface_ identifier - Validates a surface identifier against the shared contract.