Struct State 

pub struct State { /* private fields */ }

Bundle of optional connection handles. Cheap to clone — all inner types are reference-counted.

Implementations

impl State

pub async fn with_storage<S: StorageProvider>(self, storage: S) -> Result<Self>

Attach a custom StorageProvider. Probes it immediately and returns the error if the probe fails — same contract as the other backends (“fail fast at boot”).

pub fn set_storage(&mut self, storage: Arc<dyn StorageProvider>)

Attach a pre-boxed provider without re-probing. Use when the caller has already done their own validation, or when injecting a mock from tests.

pub fn has_storage(&self) -> bool

Whether a storage provider is wired.

pub fn storage(&self) -> Result<&Arc<dyn StorageProvider>>

Borrow the trait-object storage handle. Returns a Config error if no provider was wired (scaffold without --with-storage, or STORAGE_BUCKET unset in the generated init).

pub async fn from_env() -> Result<Self>

Build a State from environment variables. Tries each backend independently; missing env vars produce None fields, not errors. Connection failures DO error — if DATABASE_URL is set but unreachable, that’s a deploy-time problem and the service should fail to start.

Object storage is not initialized here — its concrete client type (opendal::Operator, AWS SDK, etc.) is scaffold-time opt-in, so this framework crate doesn’t pull those deps. The scaffolded main.rs calls State::with_storage separately when --with-storage was used.

pub fn pg(&self) -> Result<&PgPool>

Borrow the Postgres pool. Returns a Config error if DATABASE_URL was not set at boot.

pub fn has_pg(&self) -> bool

Whether the Postgres pool is available.

pub fn redis(&self) -> Result<&Client>

Borrow the Redis client. Returns a Config error if REDIS_URL was not set at boot.

pub fn has_redis(&self) -> bool

Whether the Redis client is available.

Trait Implementations

impl Clone for State

fn clone(&self) -> State

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for State

fn default() -> State

Returns the “default value” for a type.