Skip to main content

ApprovalRequest

Struct ApprovalRequest 

Source
pub struct ApprovalRequest {
Show 21 fields pub approval_request_id: ApprovalRequestId, pub approval_dispatch_effect_id: EffectId, pub run_id: RunId, pub session_id: Option<SessionId>, pub agent_id: AgentId, pub turn_id: TurnId, pub tool_call_id: ToolCallId, pub source: SourceRef, pub destination: DestinationRef, pub canonical_tool_name: String, pub tool_source: SourceRef, pub effect_class: EffectClass, pub risk_class: RiskClass, pub requested_args_ref: ContentRef, pub redacted_args_summary: String, pub policy_refs: Vec<PolicyRef>, pub dispatcher_scope: DispatcherScope, pub timeout_ms: u64, pub allowed_decisions: Vec<ApprovalDecisionKind>, pub created_at_millis: u64, pub runtime_package_fingerprint: RuntimePackageFingerprint,
}
Expand description

Carries the approval request record payload for journal, event, or fixture surfaces. Creating or cloning it only preserves serialized SDK state; append, publish, replay, or export effects are documented on the runtime and port methods that store it.

Fields§

§approval_request_id: ApprovalRequestId

Stable approval request id used for typed lineage, lookup, or dedupe.

§approval_dispatch_effect_id: EffectId

Effect id that links approval dispatch intent, response, and tool-release evidence. Use it to prove the approval decision belongs to the side effect being released.

§run_id: RunId

Run identifier used for lineage, filtering, replay, and dedupe.

§session_id: Option<SessionId>

Optional host-provided session identifier for grouping related turns.

§agent_id: AgentId

Agent identifier used for lineage, filtering, and ownership checks.

§turn_id: TurnId

Turn identifier for one loop turn within a run.

§tool_call_id: ToolCallId

Stable tool call id used for typed lineage, lookup, or dedupe.

§source: SourceRef

Source label or ref for this item; it is metadata and does not fetch content by itself.

§destination: DestinationRef

Destination label or ref for this item; it is metadata and does not deliver content by itself.

§canonical_tool_name: String

Canonical tool name used by this record or request.

§tool_source: SourceRef

Tool source used by this record or request.

§effect_class: EffectClass

Classification value for effect class. Policy and projection paths use it for finite routing decisions.

§risk_class: RiskClass

Risk classification for the operation or capability. Policy uses it to decide whether approval, sandboxing, or denial is required.

§requested_args_ref: ContentRef

Typed requested args ref reference. Resolving or executing it is a separate policy-gated step.

§redacted_args_summary: String

Redacted summary for display, logs, events, or telemetry. It should describe the value without exposing raw private content.

§policy_refs: Vec<PolicyRef>

Policy references that govern admission, projection, execution, or delivery.

§dispatcher_scope: DispatcherScope

Dispatcher scope used by this record or request.

§timeout_ms: u64

Timeout budget in milliseconds for the requested operation.

§allowed_decisions: Vec<ApprovalDecisionKind>

Allowlist for this policy or contract. Validation uses it to reject undeclared or policy-denied values.

§created_at_millis: u64

Time value in milliseconds for created at millis. Use it for timeout, ordering, or diagnostic calculations.

§runtime_package_fingerprint: RuntimePackageFingerprint

Fingerprint of the runtime package snapshot in force when this value was produced. Use it for replay, dedupe, and package-lineage checks; the field is evidence and does not execute package behavior.

Implementations§

Source§

impl ApprovalRequest

Source

pub fn validate(&self) -> Result<(), AgentError>

Validates the records::approval invariants and returns a typed error on failure. Validation is pure and does not perform I/O, dispatch, journal appends, or adapter calls.

Source

pub fn subject_ref(&self) -> EntityRef

Returns an updated records::approval value with subject ref applied. This is data construction only and does not execute the configured behavior.

Source

pub fn allows_decision(&self, decision: ApprovalDecisionKind) -> bool

Returns whether allows decision applies for this state. This is data-only and does not perform I/O, call host ports, append journals, publish events, or start processes.

Trait Implementations§

Source§

impl Clone for ApprovalRequest

Source§

fn clone(&self) -> ApprovalRequest

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 ApprovalRequest

Source§

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

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

impl<'de> Deserialize<'de> for ApprovalRequest

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for ApprovalRequest

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for ApprovalRequest

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl Eq for ApprovalRequest

Source§

impl StructuralPartialEq for ApprovalRequest

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> 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 = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,