Struct RequestPermissionRequest 

#[non_exhaustive]
pub struct RequestPermissionRequest {
    pub session_id: SessionId,
    pub title: String,
    pub description: Option<String>,
    pub subject: Option<RequestPermissionSubject>,
    pub options: Vec<PermissionOption>,
    pub meta: Option<Map<String, Value>>,
}

Available on crate feature unstable_protocol_v2 only.

Request for user permission to proceed with an operation.

Sent when the agent needs authorization before performing a sensitive operation.

See protocol docs: Requesting Permission

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

session_id: SessionId

The session ID for this request.

title: String

Human-readable title for the permission prompt.

This title is specific to the permission prompt and does not update any subject’s displayed title.

description: Option<String>

Optional human-readable explanation of why permission is needed.

This text is specific to the permission prompt and does not update any subject’s displayed content. Omitted or null both mean no separate permission description was provided.

subject: Option<RequestPermissionSubject>

Optional structured context about the operation requiring permission.

Omitted or null both mean no structured subject was provided.

options: Vec<PermissionOption>

Available permission options for the user to choose from. Must contain at least one option.

meta: Option<Map<String, Value>>

The _meta property is reserved by ACP to allow clients and agents to attach additional metadata to their interactions. Implementations MUST NOT make assumptions about values at these keys.

See protocol docs: Extensibility

Implementations

impl RequestPermissionRequest

pub fn new( session_id: impl Into<SessionId>, title: impl Into<String>, options: Vec<PermissionOption>, ) -> RequestPermissionRequest

Builds RequestPermissionRequest with the required request fields set; optional fields start unset or empty.

pub fn description( self, description: impl IntoOption<String>, ) -> RequestPermissionRequest

Sets or clears the optional description field.

pub fn subject( self, subject: impl IntoOption<RequestPermissionSubject>, ) -> RequestPermissionRequest

Sets or clears the optional subject field.

pub fn meta( self, meta: impl IntoOption<Map<String, Value>>, ) -> RequestPermissionRequest

The _meta property is reserved by ACP to allow clients and agents to attach additional metadata to their interactions. Implementations MUST NOT make assumptions about values at these keys.

See protocol docs: Extensibility

Trait Implementations

impl Clone for RequestPermissionRequest

fn clone(&self) -> RequestPermissionRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RequestPermissionRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RequestPermissionRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl IntoV1 for RequestPermissionRequest

type Output = RequestPermissionRequest

The corresponding v1 type.

fn into_v1( self, ) -> Result<<RequestPermissionRequest as IntoV1>::Output, ProtocolConversionError>

Converts this value into the corresponding v1 type.

impl JsonRpcMessage for RequestPermissionRequest

fn matches_method(method: &str) -> bool

Check if this message type matches the given method name.

fn method(&self) -> &str

The method name for the message.

fn to_untyped_message(&self) -> Result<UntypedMessage, Error>

Convert this message into an untyped message.

fn parse_message(method: &str, params: &impl Serialize) -> Result<Self, Error>

Parse this type from a method name and parameters.

impl JsonRpcRequest for RequestPermissionRequest

type Response = RequestPermissionResponse

The type of data expected in response.

impl JsonSchema for RequestPermissionRequest

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for RequestPermissionRequest

fn eq(&self, other: &RequestPermissionRequest) -> 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 RequestPermissionRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RequestPermissionRequest