Skip to main content

DrawOnAuthority

Struct DrawOnAuthority 

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

Drawing on a standing authority, as an effect.

§Why this cannot be a plain call

The remaining balance is mutable state outside the journal. A skill that read it inside the deterministic zone would make replay depend on what the store happens to hold now: a run replayed after a later draw would see a different balance, take a different branch, and produce a history that disagrees with itself. Journaling the draw makes the receipt part of the record, so replay reads what the run actually got.

§The key it deduplicates on is dispatch, not effect

Provenance::effect hashes the attempt number, so a retry carries a different key — which is right for the journal and exactly wrong here. Two attempts at one draw must consume the authority once, so the store is keyed on Provenance::dispatch, the identifier the crate defines as stable across retries of the same call. Getting this backwards spends a customer’s authorization twice for one purchase, and only under retry, which is the hardest condition to notice in testing.

Trait Implementations§

Source§

impl Clone for DrawOnAuthority

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 DrawOnAuthority

Source§

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

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

impl Effect for DrawOnAuthority

Source§

fn mutates(&self) -> bool

It changes durable state that authorizes spending, and says so to every rule reading context.mutates. The id it draws on is checked before this effect exists: StepCtx::draw refuses one untrusted data chose.

Source§

fn recovery(&self) -> Recovery

Safe to repeat, because the store deduplicates on the dispatch key and returns the original receipt. Without that idempotence this would have to be Reconcile, and every interrupted draw would wake an operator.

Source§

type Output = Drawn

What comes back. Must round-trip through JSON: replay reconstructs it from the journal rather than from the driver.
Source§

fn descriptor(&self) -> EffectDescriptor

What this effect does. Hashed (with position) into the effect key.
Source§

fn attach(&mut self, provenance: &Provenance)

Receive the run-scoped provenance for this call. Read more
Source§

fn perform<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Self::Output, EffectError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Do the thing. Called at most once per key per run; never called during replay.
Source§

fn gen_ai_operation(&self) -> Option<&'static str>

Which OpenTelemetry GenAI operation this effect is, if it is one. Read more
Source§

fn gen_ai_request(&self) -> Option<GenAiRequest>

Who this operation asks, and for what — the request half of the GenAI span attributes. Read more
Source§

fn gen_ai_response(&self, output: &Self::Output) -> Option<GenAiResponse>

What came back, split the way the convention reports it. Read more
Source§

fn retry(&self) -> RetryPolicy

How many times to repeat this effect when it fails, and how far apart. Read more
Source§

fn retries_landed(&self) -> bool

Whether a failure that landed may be tried again, within retry. Read more
Source§

fn max_sensitivity(&self) -> Sensitivity

The highest data sensitivity this sink may receive. Read more
Source§

fn sink_arguments(&self) -> Option<&Value>

The exact value this effect will send to its sink. Read more
Source§

fn rebind(&mut self, _arguments: Value) -> bool

Bind arguments in place of the ones this effect was built over, where it can — what a declared redaction at a sink needs. Read more
Source§

fn outbound_bytes(&self) -> u64

How many bytes dispatching this effect sends out of the plane. Read more
Source§

fn credential_binding(&self) -> Option<CredentialBinding>

Whom the credential this effect presents names, for an effect that presents one to another party. Read more
Source§

fn protected_fields(&self) -> &[ProtectedField]

Field-specific source and sensitivity rules for a structured sink. Read more
Source§

fn delegation_depth(&self) -> Option<usize>

The resulting delegation depth when this effect hands authority onward. Read more
Source§

fn source(&self) -> SourceId

The provenance identity an untrusted result of this effect carries. Read more
Source§

fn trust(&self) -> Trust

How much this effect’s output may be trusted. Read more
Source§

fn output_sensitivity(&self) -> Sensitivity

How sensitive this effect’s output is, at minimum. Read more
Source§

fn spend(&self, _output: &Self::Output) -> Spend

What this effect consumed. Read more
Source§

fn reconcile<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Reconciliation<Self::Output>, EffectError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Ask the provider whether a call landed. 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<E> AnyEffect for E
where E: Effect,

Source§

fn spend_erased(&self, output: &Value) -> Spend

Round-trips the output to ask the typed effect what it cost.

A type that cannot be deserialized from its own serialization is already broken for replay — Effect::Output requires the round-trip, and the journal reconstructs every output that way. Charging zero here is the same answer replay would reach, and the defect surfaces where it belongs.

Source§

fn gen_ai_response_erased(&self, output: &Value) -> Option<GenAiResponse>

Round-trips the output, for the reason spend_erased does.

Source§

fn descriptor(&self) -> EffectDescriptor

Source§

fn attach_erased(&mut self, provenance: &Provenance)

Source§

fn gen_ai_operation(&self) -> Option<&'static str>

Source§

fn mutates(&self) -> bool

Source§

fn recovery(&self) -> Recovery

Source§

fn retry(&self) -> RetryPolicy

Source§

fn retries_landed(&self) -> bool

Source§

fn max_sensitivity(&self) -> Sensitivity

Source§

fn sink_arguments(&self) -> Option<&Value>

Source§

fn rebind_erased(&mut self, arguments: Value) -> bool

Source§

fn outbound_bytes(&self) -> u64

Source§

fn credential_binding(&self) -> Option<CredentialBinding>

Source§

fn protected_fields(&self) -> &[ProtectedField]

Source§

fn delegation_depth(&self) -> Option<usize>

Source§

fn source(&self) -> SourceId

Source§

fn trust(&self) -> Trust

Source§

fn output_sensitivity(&self) -> Sensitivity

Source§

fn gen_ai_request(&self) -> Option<GenAiRequest>

Source§

fn perform_erased<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Value, EffectError>> + Send + 'async_trait>>
where 'life0: 'async_trait, E: 'async_trait,

Source§

fn reconcile_erased<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Reconciliation<Value>, EffectError>> + Send + 'async_trait>>
where 'life0: 'async_trait, E: 'async_trait,

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<E> BuildsEffect<E> for E
where E: Effect,

Source§

fn into_effect(self) -> Result<E, StepError>

The effect, or the error that stops the step instead. Read more
Source§

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

Source§

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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<T> Instrument for T

Source§

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

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

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
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

impl<T> MaybeSend for T
where T: Send,

Source§

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

Source§

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
Source§

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
Source§

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

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

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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
Source§

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

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