Expand description
Photon runtime builder and process-wide configuration — Integrating the host.
Re-exports§
pub use admin::collect_admin_snapshot;pub use admin::AdminBackendSummary;pub use admin::AdminCheckpointSummary;pub use admin::AdminHandlerSummary;pub use admin::AdminSnapshot;pub use admin::AdminTopicSummary;
Modules§
- admin
- Read-only admin introspection for host ops UIs.
- runtime
- Host-facing runtime wiring helpers (Integrating the host).
Structs§
- Backend
Capabilities - Capabilities advertised by a storage port (surfaced via
crate::backend::GenericPhotonBackend). - Backend
Context - Shared builder context for storage adapter install fns.
- Envelope
- Event envelope with decoded payload.
- Event
- Published event with payload and metadata.
- Executor
Controller - Controls background handler dispatch tasks started by
Photon::start_executor. - Generic
Photon Backend - Unified backend — all storage adapters install this wrapping their port.
- Group
Opts - Options specific to consumer-group subscriptions.
- Handler
Ctx - Delivery metadata for a single handler invocation.
- Handler
Descriptor - Descriptor for a
#[photon::subscribe]handler (inventory + executor dispatch). - Handler
Registry - Registry of inventory-submitted subscription handlers.
- InProc
Storage Port - In-process storage for the
memadapter tier. - Photon
- Main Photon runtime handle.
- Photon
Builder - Builder for constructing
Photonruntimes — Integrating the host. - Photon
Runtime State - Shared storage port, executor services, and handler dispatch controller.
- Subscribe
Opts - Options for subscribing to a topic.
- Subscription
- Subscription handler registration.
- Subscription
Handle - Placeholder for future subscription lifecycle control (cancel, pause).
- Topic
Descriptor - Descriptor for a registered topic (from
#[photon::topic]macro). - Topic
Registry - Registry of all topics discovered via
#[photon::topic]. - Transport
Crypto - Symmetric payload encryption (XChaCha20-Poly1305).
Enums§
- Photon
Error - Errors that can occur in Photon operations.
- Subscription
Mode - Subscription mode.
Traits§
- Photon
Backend - Backend for publish/subscribe delivery and checkpoint persistence.
- Storage
Port - Storage adapter contract — append, subscribe, checkpoints, and optional retention.
Functions§
- configure
- Configure the default Photon instance used by macro-generated convenience helpers
(
Type::publish()/Type::subscribe()). - default
- Clone of the process-wide Photon set by
configure, if any. - resolve_
photon_ remote_ base_ url - Origin + path prefix before
/api/photon(no trailing slash).
Type Aliases§
- Embedded
Backend - Back-compat alias for the default in-process
memtierGenericPhotonBackend. - Result
- Result type alias for Photon operations.