Struct ApprovalRequest 

pub struct ApprovalRequest {
    pub task_id: Option<TaskId>,
    pub call_id: Option<ToolCallId>,
    pub id: ApprovalId,
    pub request_kind: String,
    pub reason: ApprovalReason,
    pub summary: String,
    pub metadata: MetadataMap,
}

A request sent to the host when a tool execution needs human approval.

The agent loop surfaces this to the user. Once the user responds, the loop can re-submit the tool call via ToolExecutor::execute_approved.

Fields

task_id: Option<TaskId>

Runtime task identifier associated with this approval request, if any.

call_id: Option<ToolCallId>

The originating tool call id when this approval was raised from a tool invocation. Hosts can use this to resolve specific approvals.

id: ApprovalId

Stable identifier so the executor can match the approval to its request.

request_kind: String

The PermissionRequest::kind string that triggered the approval flow.

reason: ApprovalReason

Why approval is needed.

summary: String

Human-readable summary shown to the user.

metadata: MetadataMap

Arbitrary metadata carried from the original permission request.

Implementations

impl ApprovalRequest

pub fn new( id: impl Into<ApprovalId>, request_kind: impl Into<String>, reason: ApprovalReason, summary: impl Into<String>, ) -> Self

Builds an approval request with no task or call id.

pub fn with_task_id(self, task_id: impl Into<TaskId>) -> Self

Sets the associated task id.

pub fn with_call_id(self, call_id: impl Into<ToolCallId>) -> Self

Sets the associated tool call id.

pub fn with_metadata(self, metadata: MetadataMap) -> Self

Replaces the approval metadata.

Trait Implementations

impl Clone for ApprovalRequest

fn clone(&self) -> ApprovalRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ApprovalRequest

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

Formats the value using the given formatter.

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

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ApprovalRequest

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for ApprovalRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ApprovalRequest

impl StructuralPartialEq for ApprovalRequest