Struct ClientAuthCapabilities 

#[non_exhaustive]
pub struct ClientAuthCapabilities {
    pub terminal: Option<TerminalAuthCapabilities>,
    pub meta: Option<Map<String, Value>>,
}

Available on crate feature unstable_protocol_v2 only.

Authentication capabilities supported by the client.

Advertised during initialization to inform the agent which authentication method types the client can handle. This governs opt-in types that require additional client-side support.

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.

terminal: Option<TerminalAuthCapabilities>

Whether the client supports terminal authentication methods.

Optional. Omitted and null are equivalent and mean the client does not advertise support. The client should supply {} only when it can reproduce the configured agent invocation in an interactive terminal. Supplying {} means the agent may include terminal entries in its authentication methods.

meta: Option<Map<String, Value>>

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

See protocol docs: Extensibility

Implementations

impl ClientAuthCapabilities

pub fn new() -> ClientAuthCapabilities

Builds an empty ClientAuthCapabilities; use builder methods to advertise supported sub-capabilities.

pub fn terminal( self, terminal: impl IntoOption<TerminalAuthCapabilities>, ) -> ClientAuthCapabilities

Whether the client supports terminal authentication methods.

Omitted and null are equivalent and mean the client does not advertise support. The client should supply {} only when it can reproduce the configured agent invocation in an interactive terminal. Supplying {} means the agent may include AuthMethod::Terminal entries in its authentication methods.

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

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 ClientAuthCapabilities

fn clone(&self) -> ClientAuthCapabilities

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClientAuthCapabilities

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

Formats the value using the given formatter.

impl Default for ClientAuthCapabilities

fn default() -> ClientAuthCapabilities

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ClientAuthCapabilities

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ClientAuthCapabilities

impl JsonSchema for ClientAuthCapabilities

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 ClientAuthCapabilities

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ClientAuthCapabilities

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 ClientAuthCapabilities