Skip to main content

StoreLimit

Enum StoreLimit 

Source
#[non_exhaustive]
pub enum StoreLimit { EventDataLen, TagsPerEvent, EventsPerBatch, MetadataLen, TagsPerBatch, }
Expand description

Which capacity limit an append exceeded.

Five variants, and no QueryItems: a query-item refusal is not an append outcome, so that variant would name a refusal no append could produce, and a store that will not evaluate a large query fails it through its own error. MetadataLen is the one variant with no floor behind it (ADR-0043): a refusal channel, with no capacity guaranteed.

§The variant this enum does not have

Every variant here but one names one factor. The exception, TagsPerBatch, is a batch-scope count (ADR-0100). None of them can express a refusal of the batch’s total size in bytes — the product the module documentation works out above — and that is the refusal a store in the FoundationDB or DynamoDB family would need, because what those systems bound is the transaction’s bytes rather than any one row in it or any one count across it.

Such a store cannot route the refusal elsewhere either: [FROZEN] VT-25 forbids reporting a capacity refusal through AppendError::Store, which is the channel it would otherwise reach for.

This enum is #[non_exhaustive], so a variant for it is additive at any time and is not owed to a release. Naming the gap is what is owed now: the decision it waits on is what floor such a variant would state, and no adapter in this workspace is in that family to inform the number.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

EventDataLen

One event’s data payload was larger than the store accepts.

§

TagsPerEvent

One event carried more tags than the store accepts.

§

EventsPerBatch

The batch held more events than the store accepts in one append.

§

MetadataLen

One event’s metadata was larger than the store accepts.

Distinct from EventDataLen, which is about data alone: a store refusing an event for its metadata and naming EventDataLen would be naming the wrong field. Its guaranteed_minimum is 0, because the contract guarantees no metadata capacity (ADR-0043). Whether data and metadata should share one budget instead is open, and is phase 13’s.

§

TagsPerBatch

The batch carried more tags in total, summed over all its events, than the store accepts in one append.

Distinct from TagsPerEvent: every event of the batch may be within its own ceiling while their sum is not. Its guaranteed_minimum is MIN_SUPPORTED_TAGS_PER_BATCH, which VT-22 and VT-24 already imply (VT-36, ADR-0100). A batch refused for it can be split and retried; one refused for a per-event limit cannot.

Implementations§

Source§

impl StoreLimit

Source

pub const fn guaranteed_minimum(self) -> usize

The floor every store must clear for this limit.

A caller that has hit a store’s actual limit can compare against this to tell “this store is stricter than the contract allows” — a conformance bug — from “this payload was always going to be too big to replicate”.

For MetadataLen it is 0, so that comparison can never report a conformance bug: no metadata capacity is guaranteed.

Trait Implementations§

Source§

impl Clone for StoreLimit

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 Copy for StoreLimit

Source§

impl Debug for StoreLimit

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for StoreLimit

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for StoreLimit

Source§

impl Hash for StoreLimit

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for StoreLimit

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for StoreLimit

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
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.

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> 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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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.