Struct Platform 

pub struct Platform {

    pub clock: Arc<dyn Clock>,
    pub events: EventBus,
    pub storage: Arc<dyn Storage>,
    pub cache: Cache,
    pub secrets: Arc<dyn SecretStore>,
    pub settings: Settings,
    pub notifications: Arc<dyn NotificationService>,
    pub jobs: Jobs,
    pub sync: SyncEngine,
    pub accounts: AccountService,
    pub connectors: ConnectorRegistry,
    pub opener: Option<Arc<dyn Opener>>,
    pub http: Option<Arc<dyn HttpClient>>,
}

The platform services every module may rely on.

Cloning is cheap and shares the same instances.

Optional fields are capabilities the product did not grant. They are None because the composition root left them out, not because they are switched off at runtime — a build that cannot reach the network is a build that cannot reach the network.

Fields

clock: Arc<dyn Clock>

events: EventBus

storage: Arc<dyn Storage>

cache: Cache

secrets: Arc<dyn SecretStore>

settings: Settings

notifications: Arc<dyn NotificationService>

jobs: Jobs

Background jobs: progress, cancellation, uniform lifecycle.

sync: SyncEngine

Decides when registered sync targets run.

accounts: AccountService

Connected accounts across all connectors.

connectors: ConnectorRegistry

The connectors this build was compiled with.

opener: Option<Arc<dyn Opener>>

Present only when the product declared the capability to open external URLs.

http: Option<Arc<dyn HttpClient>>

Present only when the product talks to external services.

Implementations

impl Platform

pub fn http(&self) -> Result<Arc<dyn HttpClient>>

The HTTP client, or a configuration error naming what is missing.

Modules call this instead of unwrapping the field, so a product that forgot to wire a client gets an actionable message rather than a panic.

pub fn opener(&self) -> Result<Arc<dyn Opener>>

The URL opener, or a permission error.

Trait Implementations

impl Clone for Platform

fn clone(&self) -> Platform

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Platform

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.