Struct Usecase 

pub struct Usecase { /* private fields */ }

An identifier for a workload in Objectstore, along with defaults to use for all operations within that Usecase.

Usecases need to be statically defined in Objectstore’s configuration server-side. Objectstore can make decisions based on the Usecase. For example, choosing the most suitable storage backend.

Implementations

impl Usecase

pub fn new(name: &str) -> Self

Creates a new Usecase.

pub fn name(&self) -> &str

Returns the name of this usecase.

pub fn compression(&self) -> Option<Compression>

Returns the compression algorithm to use for operations within this usecase.

pub fn with_compression( self, compression: impl Into<Option<Compression>>, ) -> Self

Sets the compression algorithm to use for operations within this usecase.

It’s still possible to override this default on each operation’s builder.

By default, Compression::Zstd is used. Pass None to disable compression.

pub fn expiration_policy(&self) -> ExpirationPolicy

Returns the expiration policy to use by default for operations within this usecase.

pub fn with_expiration_policy(self, expiration_policy: ExpirationPolicy) -> Self

Sets the expiration policy to use for operations within this usecase.

It’s still possible to override this default on each operation’s builder.

By default, ExpirationPolicy::Manual is used, meaning that objects won’t automatically expire.

pub fn scope(&self) -> Scope

Creates a new custom Scope.

Add parts to it using Scope::push.

Generally, Usecase::for_organization and Usecase::for_project should fit most usecases, so prefer using those methods rather than creating your own custom Scope.

pub fn for_organization(&self, organization: u64) -> Scope

Creates a new Scope tied to the given organization.

pub fn for_project(&self, organization: u64, project: u64) -> Scope

Creates a new Scope tied to the given organization and project.

Trait Implementations

impl Clone for Usecase

fn clone(&self) -> Usecase

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Usecase

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

Formats the value using the given formatter.