Skip to main content

Module operation

Module operation 

Source
Expand description

Allocation-free operation preparation and checked response policy.

Structs§

AttemptBudget
Nonzero maximum number of attempts sharing one authority.
CanonicalPlanFingerprint
Caller-buffer exact plan-confirm input, cleared in full on drop.
CheckedResponse
Response that passed one operation’s complete provider-neutral policy.
CheckedResponseGuard
Policy-checked response that owns cleanup of its caller storage.
CostPermit
Single-owner authority for one exact price-bounded cost plan.
CurrencyCode
Exact ISO-style uppercase currency code.
DestructivePermit
Single-owner authority for one destructive mutation plan.
MutationPermit
Single-owner authority for one non-destructive mutation plan.
OperationId
Validated static identifier assigned by a provider specification.
OperationMetadata
Complete operation safety metadata without permissive defaults.
OwnedPreparationStorage
Fallibly allocated preparation buffers cleared in full on drop.
PermitAttempt
One in-flight attempt. Dropping it records uncertain delivery.
PermitContext
Exact bounded context binding a permit to caller policy.
PermitExecutionError
Prepared execution failure plus the fail-closed permit disposition.
PermitIdempotencyKey
Borrowed caller-owned identity used only for exact reconciliation matching.
PermitTimestamp
Caller-observed wall-clock timestamp in Unix seconds.
PermitValidity
Caller-owned issuance and expiry observations.
PlanConfirmation
Complete immutable plan-confirm inputs.
PlanCost
Exact caller-observed price and spending ceiling in common scaled units.
PlanFingerprintDigest
Caller-buffer strong digest of a plan confirmation, cleared on drop.
PlanFingerprintRef
Borrowed exact or strong-digest plan identity.
PlanSubject
One prepared request inseparably bound to a validated plan confirmation.
PreparationCapacityProfile
Named, bounded storage capacities for request preparation.
PreparationStorage
Caller-owned target and request-body storage supplied to preparation.
PreparationStorageGuard
Caller-owned preparation buffers that are cleared together on drop.
PreparedRequest
Complete request, endpoint, operation metadata, and response policy.
ProviderService
Provider service and immutable endpoint trust policy.
ReconciliationToken
Generation-bound reconciliation authority returned after uncertain delivery.
RecoveryToken
Generation-bound recovery authority returned only for NotSent.
ResponsePolicy
Complete checked-response policy.
SharedCostPermit
Shared atomic price-bounded authority.
SharedDestructivePermit
Shared atomic destructive authority.
SharedMutationPermit
Shared atomic mutation authority.
SharedPermitState
Caller-owned atomic authority shared by all explicit permit-handle clones.

Enums§

AttemptBudgetError
Invalid attempt budget.
BodyReplayability
Whether one prepared request body can be sent again byte-for-byte.
ContentTypePolicy
Response content-type requirement and accepted media types.
CostIntent
Whether executing the operation may directly incur provider charges.
CurrencyCodeError
Invalid three-letter currency code.
ExecutionPermitError
Permit authorization or lifecycle failure.
OperationIdError
Invalid provider operation identifier.
OperationImpact
Provider operation impact.
OperationMetadataError
Incoherent operation metadata.
PermitContextError
Invalid account, tenant, or permit-context value.
PermitDisposition
State transition produced by one completed or failed attempt.
PermitIdempotencyKeyError
Invalid caller-provided repetition identity.
PermitScope
Runtime execution authority required by an operation.
PermitState
Observable permit lifecycle state.
PermitValidityError
Invalid bounded permit-validity interval.
PlanChange
Caller assessment of whether the planned request changes effective state.
PlanCostError
Invalid cost confirmation.
PlanFingerprintBuildError
Plan-confirm construction failure.
PlanFingerprintScope
Optional exact account or tenant identity.
PreparationCapacityError
Failure while selecting or allocating preparation storage.
PreparedExecutionError
Prepared execution failure with transport details redacted from diagnostics.
PreparedRequestPolicyError
Incoherent policy supplied while constructing a prepared request.
ReplayPolicy
Repetition policy selected during plan confirmation.
RequestIdPolicy
Lifecycle policy for provider request identifiers.
RequestSemantics
HTTP request semantics independent of provider impact.
ResponseBodyPolicy
Expected response-body shape.
ResponsePolicyError
Response rejected before provider decoding.
ResponsePolicyValidationError
Invalid response-policy construction.
RetryEligibility
Whether caller-owned retry policy may retry the operation.

Constants§

DEFAULT_BODY_BYTES
Default request-body capacity in bytes.
EMBEDDED_BODY_BYTES
Embedded request-body capacity in bytes.
LARGE_BODY_BYTES
Large request-body capacity in bytes.

Traits§

PermitClock
Time source sampled inside permit execution immediately before dispatch.
PrepareOperation
Typed provider operation that can prepare one complete request.

Functions§

build_canonical_plan
Builds exact canonical plan-confirm bytes into caller-owned storage.
build_plan_digest
Builds a caller-selected collision-resistant digest and clears scratch.