Skip to main content

Usecase

Struct Usecase 

Source
pub struct Usecase { /* private fields */ }
Expand description

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.

Names must be 3–64 ASCII characters from [A-Za-z0-9_-]. Any permitted character may appear in any position. Names are case-sensitive and are never normalized.

Implementations§

Source§

impl Usecase

Source

pub fn new(name: &str) -> Result<Self, InvalidUsecaseName>

Creates a Usecase, returning an error if the name is invalid.

Use Self::from_static for statically defined names.

§Errors

Returns InvalidUsecaseName if the name violates the naming rules on Usecase.

Source

pub const fn from_static(name: &'static str) -> Self

Creates a Usecase for a statically defined name.

Use Self::new for dynamic names. The result can initialize a static:

use objectstore_client::Usecase;

static ATTACHMENTS: Usecase = Usecase::from_static("attachments");
assert_eq!(ATTACHMENTS.name(), "attachments");
§Panics

Panics if the name violates the naming rules on Usecase. In a const context, this panic is reported as a compile error.

Source

pub fn name(&self) -> &str

Returns the name of this usecase.

Source

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

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

Source

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.

Source

pub fn expiration_policy(&self) -> ExpirationPolicy

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

Source

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.

Source

pub fn resumable_threshold_bytes(&self) -> Option<u64>

Returns the automatic resumable upload threshold, or None if disabled.

Source

pub fn with_resumable_threshold_bytes( self, threshold: impl Into<Option<u64>>, ) -> Self

Sets the minimum remaining input size for automatic resumable uploads.

Defaults to 256 MiB, measured before client compression. Pass None to disable or zero to include every supported payload. Individual uploads can override this using crate::PutBuilder::resumable_threshold_bytes. See crate::PutBuilder for eligibility.

Source

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.

Source

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

Creates a new Scope tied to the given organization.

Source

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

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

Trait Implementations§

Source§

impl Clone for Usecase

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Usecase

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more