Struct StorageConfig 

#[non_exhaustive]
pub struct StorageConfig {
    pub max_object_bytes: usize,
    pub max_objects_per_user: u32,
    pub max_bytes_per_user: u64,
    pub write_rate: u32,
    pub write_rate_window_secs: u32,
    pub server_collections: Vec<String>,
    pub admin_in_openapi: bool,
}

Available on crate feature storage only.

The storage module’s settings. Build in code from StorageConfig::default by changing fields, or let the module read [modules.storage].

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

max_object_bytes: usize

The largest value, in bytes of its JSON. Default 256 KiB (the protocol’s default); at most 4 MiB (a batch read of larger objects may then exceed the batch budget and answer 413).

max_objects_per_user: u32

The most objects one user may own (over it: 403 quota_exceeded). Default 1000. Counts every object, but only the owner’s own writes are refused by it (server code and admins may always write).

max_bytes_per_user: u64

The most bytes (of value JSON) all of one user’s objects may hold together (over it: 403 quota_exceeded). Default 4 MiB (DEFAULT_MAX_BYTES_PER_USER): sixteen objects of the largest default size, or hundreds of typical saves, and a bounded disk cost per account (10 000 accounts at most ~40 GiB). Like the object quota it binds only the owner’s writes.

write_rate: u32

Owner writes (PUT, DELETE, each batch put) per user within write_rate_window_secs, as a token bucket: a burst of this many, then one every window / write_rate (over it: 429 rate_limited + retry_after_ms). Default 60 (per 60 s: a burst of 60, then one a second). 0 = no limit. Server code and admins are not limited.

write_rate_window_secs: u32

The window of write_rate, seconds. Default 60.

server_collections: Vec<String>

Server-owned collections: the owner may read objects there but never create, change or delete one (403 forbidden), so a player cannot pre-create an object the server will own (e.g. wallet/gold). An entry x covers the collection x and every collection starting with x. (server covers server and server.wallet). New objects that server code or an admin creates there are server-locked unless write says otherwise. Default ["server"].

admin_in_openapi: bool

List the /v1/admin/users/{user}/storage routes in the OpenAPI document. Default false (like the auth module’s admin routes).

Implementations

impl StorageConfig

pub fn validate(&self) -> Result<(), Error>

Check every setting.

pub fn is_server_collection(&self, collection: &str) -> bool

Whether the owner may never write in collection (server_collections).

pub fn put_body_limit(&self) -> usize

The request body limit of a single-object PUT: the value plus room for the envelope (at least the protocol’s PUT_BODY_LIMIT_BYTES).

Trait Implementations

impl Clone for StorageConfig

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StorageConfig

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

Formats the value using the given formatter.

impl Default for StorageConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for StorageConfig

where StorageConfig: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.