Struct Clock 

pub struct Clock;

Reads the wall clock.

Non-mutating and freely retryable: re-reading a clock after a crash is harmless, which is why this is one of the few effects that does not need an operator when its outcome is unknown.

Trait Implementations

impl Clone for Clock

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Clock

impl Debug for Clock

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

Formats the value using the given formatter.

impl Effect for Clock

fn trust(&self) -> Trust

Trusted: does not cross a trust boundary.

The journaled clock. The instant comes from the runtime and is written to the journal, so it is the runtime’s own data rather than the world’s — and a timestamp that arrived untrusted could not be used for the deadline arithmetic it exists for.

type Output = OffsetDateTime

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

fn descriptor(&self) -> EffectDescriptor

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

fn mutates(&self) -> bool

Whether this mutates external state.

fn recovery(&self) -> Recovery

What to do when the outcome is unknown — after a crash, or after an InDoubt failure. The two are the same situation reached from different directions.

fn max_sensitivity(&self) -> Sensitivity

The highest data sensitivity this sink may receive.

fn perform<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Timestamp, 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.

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

Receive the run-scoped provenance for this call.

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

Which OpenTelemetry GenAI operation this effect is, if it is one.

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

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

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

What came back, split the way the convention reports it.

fn retry(&self) -> RetryPolicy

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

fn retries_landed(&self) -> bool

Whether a failure that landed may be tried again, within retry.

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

The exact value this effect will send to its sink.

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.

fn carried(&self) -> Option<Tainted<Value>>

What this effect sends beside its bound arguments, with the label of everything in it.

fn rebind_carried(&mut self, _carried: Value) -> bool

Bind a redacted copy of carried, where the effect can.

fn outbound_bytes(&self) -> u64

How many bytes dispatching this effect sends out of the plane.

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

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

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

Field-specific source and sensitivity rules for a structured sink.

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

The resulting delegation depth when this effect hands authority onward.

fn source(&self) -> SourceId

The provenance identity an untrusted result of this effect carries.

fn output_sensitivity(&self) -> Sensitivity

How sensitive this effect’s output is, at minimum.

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

What this effect consumed.

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.