Expand description
Stable public facade for the Aequora Rust SDK.
Most applications should depend on this crate plus explicitly selected adapter crates. The facade exposes semantic client/server concepts, not journal rows, cursors, database drivers, HTTP frameworks, scheduler queues, or runtime topology.
Re-exports§
pub use aequora_registry_generated as registry;
Modules§
- experimental
- Unstable APIs may be added here without the facade’s stable semver guarantee.
- prelude
- Intentionally small set of imports for ordinary application use.
Structs§
- Aequora
Client - Cheaply clonable reference to one client runtime.
- Aequora
Client Builder - Runtime-validated builder for the stable high-level client.
- Aequora
Server - Cheaply clonable high-level server core. Transport integration belongs in
aequora-axumor another adapter crate. - Aequora
Server Builder - Runtime-validated server builder.
- Blob
Handle - Optional blob namespace. Raw storage handles are never exposed.
- Bootstrap
Progress - Bounded bootstrap progress hint. Durable bootstrap state remains queryable.
- Client
SdkConfig - Bounded high-level client policy.
- Conflict
Handle - Semantic conflict namespace.
- Data
Change - Redacted advisory data-change notification.
- Device
Id - Identity of a client installation.
- Diagnostics
Handle - Bounded diagnostics namespace.
- Domain
Registry - Immutable, validated domain-handler registry.
- Domain
Registry Builder - Validating domain registry builder.
- Entity
Id - Stable identity of a synchronized entity.
- Entity
Ref - Stable reference to an application entity involved in a conflict.
- Event
Stream - Event receiver with explicit best-effort lag semantics.
- Mutation
Receipt - Receipt returned only after the local adapter reports durable intent.
- Operation
Encoding Error - Bounded failure returned by an application payload encoder.
- Operation
Handle - Operation inspection namespace.
- Operation
Id - Permanent idempotency key for one logical operation.
- Operation
Kind - Stable registry identity for an application operation kind. Zero is reserved.
- Operation
Ref - One operation plus bounded authoritative-confirmation helper.
- Operation
Schema Version - Version of one application operation’s payload schema. Zero is reserved.
- Operation
Update - Advisory operation-state notification. Durable state remains queryable.
- Scope
Handle - Partial-synchronization scope namespace.
- Sync
Result - Stable summary of one bounded synchronization attempt.
- Sync
Scope Id - Opaque identity of a synchronization scope.
- Tenant
Id - Identity of an isolated tenant.
Enums§
- Aequora
Error - One top-level SDK error with semver-stable categories and codes.
- Aequora
Error Code - Stable public error code, independent from error text and internal sources.
- Domain
Registration Error - Domain handler registration failure detected before traffic is served.
- Local
Commit Status - Local durability result. It never implies authoritative acceptance.
- Operation
State - Stable, high-level lifecycle of a submitted operation.
- Retry
Class - Stable retry classification for application policy and FFI consumers.
- Scope
Subscription State - Public result of a scope subscription request.
- Server
Operation Outcome - Stable server-side operation outcome. Business rejection is not a system failure.
- Stable
Server Error - Stable high-level server error.
- Sync
Event - Best-effort UI notification. Missing an event never loses durable state.
- Sync
Next Action - Next safe action after a bounded synchronization attempt.
- Sync
Reason - Bounded scheduler hint. It cannot bypass admission or retry limits.
- Sync
Status - Observable transport-independent background synchronization state.
Traits§
- Operation
- Application operation submitted through the high-level SDK.
Type Aliases§
- ScopeId
- Public name used by application-facing SDK documentation.