Struct AuthMethodTerminal 

#[non_exhaustive]
pub struct AuthMethodTerminal {
    pub id: AuthMethodId,
    pub name: String,
    pub description: Option<String>,
    pub args: Vec<String>,
    pub env: HashMap<String, String>,
    pub meta: Option<Map<String, Value>>,
}

Available on crate feature unstable_protocol_v2 only.

UNSTABLE

This capability is not part of the spec yet, and may be removed or changed at any point.

Terminal-based authentication method.

The client runs an interactive terminal for the user to authenticate via a TUI.

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.

id: AuthMethodId

Unique identifier for this authentication method.

name: String

Human-readable name of the authentication method.

description: Option<String>

Optional description providing more details about this authentication method.

args: Vec<String>

Additional arguments to pass when running the agent binary for terminal auth.

env: HashMap<String, String>

Additional environment variables to set when running the agent binary for terminal auth.

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 AuthMethodTerminal

pub fn new( id: impl Into<AuthMethodId>, name: impl Into<String>, ) -> AuthMethodTerminal

Available on crate feature unstable_auth_methods only.

pub fn args(self, args: Vec<String>) -> AuthMethodTerminal

Available on crate feature unstable_auth_methods only.

Additional arguments to pass when running the agent binary for terminal auth.

pub fn env(self, env: HashMap<String, String>) -> AuthMethodTerminal

Available on crate feature unstable_auth_methods only.

Additional environment variables to set when running the agent binary for terminal auth.

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

Available on crate feature unstable_auth_methods only.

Optional description providing more details about this authentication method.

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

Available on crate feature unstable_auth_methods only.

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 AuthMethodTerminal

fn clone(&self) -> AuthMethodTerminal

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AuthMethodTerminal

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AuthMethodTerminal

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for AuthMethodTerminal

impl IntoV1 for AuthMethodTerminal

Available on crate feature unstable_auth_methods only.

type Output = AuthMethodTerminal

The corresponding v1 type.

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

Converts this value into the corresponding v1 type.

impl JsonSchema for AuthMethodTerminal

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 AuthMethodTerminal

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

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 AuthMethodTerminal