#[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
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
impl StoreLimit
Sourcepub const fn guaranteed_minimum(self) -> usize
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.