Struct Storage 

pub struct Storage { /* private fields */ }

Available on crate feature storage only.

The storage module: per-user JSON objects with versions, conditional writes, batches, the server write lock, quotas, hooks and audited admin access (see crate::storage). Name storage; settings in [modules.storage] (StorageConfig); needs the auth module registered first.

use net_backend_server::auth::Auth;
use net_backend_server::storage::Storage;
use net_backend_server::{Config, NetBackendServer};

NetBackendServer::new(Config::load()?).module(Auth::new()).module(Storage::new()).run().await

Implementations

impl Storage

pub fn new() -> Self

The module with settings from [modules.storage] (defaults if absent).

pub fn with_config(self, config: StorageConfig) -> Self

Use these settings instead of [modules.storage] (which must then be absent).

pub fn service(&self) -> Option<&StorageService>

The service, once the server is built.

Trait Implementations

impl Debug for Storage

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

Formats the value using the given formatter.

impl Default for Storage

fn default() -> Self

Returns the “default value” for a type.

impl Module for Storage

fn name(&self) -> &'static str

The module’s name: [a-z][a-z0-9_]*, at most 32 bytes, not reserved (RESERVED_MODULE_NAMES). It names its migrations namespace, its config section ([modules.<name>]) and its entry in /v1/info. Stable public API once released.

fn depends_on(&self) -> &'static [&'static str]

The modules this one needs, by name (e.g. ["auth"] for tables with a foreign key to the accounts). Each must be registered BEFORE this module, so its migrations run first and its state values exist in setup; the build fails otherwise.

fn migrations(&self, dialect: Dialect) -> Vec<Migration>

The module’s migrations for a dialect, any order (they are sorted by version). Embedded SQL (e.g. include_str!); the app can publish and own them (migrations publish <name>).

fn setup(&self, setup: &mut Setup<'_>) -> Result<(), Error>

Prepare the module when the server is built (after the database connected, before the hooks and routes): read its [modules.<name>] section, register its services as state values, add an Authenticator or a RateLimiter. An error stops the build.

fn routes(&self) -> OpenApiRouter<AppState>

The module’s HTTP routes (full paths, e.g. the protocol’s /v1/storage/... constants). Handlers registered with utoipa_axum::routes! appear in the OpenAPI document.

fn openapi(&self) -> Option<OpenApi>

Extra OpenAPI parts (schemas, tags) not tied to a route.

fn register_hooks(&self, hooks: &mut Hooks)

Register hooks (the module’s own defaults, or hooks into other modules’ events).

fn ws_handlers(&self, handlers: &mut WsHandlers)

The module’s WebSocket request handlers and documented pushes (see crate::ws), e.g. handlers.call::<JoinRoom, _, _>(join). A kind may be registered once across the app and all modules (a duplicate stops the build).

fn commands(&self) -> Vec<Arc<dyn AppCommand>>

The module’s command-line commands (see crate::command), e.g. user:create.

fn start<'a>(&'a self, state: &'a AppState) -> BoxFuture<'a, Result<(), Error>>

Start background work (called once before the server accepts requests, in registration order). Wait on state.shutdown() to stop. An error, a panic or running longer than server.module_start_timeout_secs aborts the start (modules already started shut down).

fn shutdown<'a>(&'a self, state: &'a AppState) -> BoxFuture<'a, ()>

Clean up after the in-flight requests drained (reverse registration order). Bounded by server.module_shutdown_timeout_secs; a panic is caught and logged.