Enum AuthMethod 

#[non_exhaustive]
pub enum AuthMethod {
    EnvVar(AuthMethodEnvVar),
    Terminal(AuthMethodTerminal),
    Other(OtherAuthMethod),
    Agent(AuthMethodAgent),
}

Available on crate feature unstable_protocol_v2 only.

Describes an available authentication method.

The type field acts as the discriminator in the serialized JSON form. When no type is present, the method is treated as agent.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

EnvVar(AuthMethodEnvVar)

Available on crate feature unstable_auth_methods only.

UNSTABLE

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

User provides a key that the client passes to the agent as an environment variable.

Terminal(AuthMethodTerminal)

Available on crate feature unstable_auth_methods only.

UNSTABLE

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

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

Other(OtherAuthMethod)

Custom or future authentication method.

Values beginning with _ are reserved for implementation-specific extensions. Unknown values that do not begin with _ are reserved for future ACP variants.

Clients that do not understand this method type should preserve the raw payload when storing, replaying, proxying, or forwarding initialization data, and otherwise ignore the method or display it generically.

Agent(AuthMethodAgent)

Agent handles authentication itself.

This is the default when no type is specified.

Implementations

impl AuthMethod

pub fn id(&self) -> &AuthMethodId

The unique identifier for this authentication method.

pub fn name(&self) -> &str

The human-readable name of this authentication method.

pub fn description(&self) -> Option<&str>

Optional description providing more details about this authentication method.

pub fn meta(&self) -> 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

Trait Implementations

impl Clone for AuthMethod

fn clone(&self) -> AuthMethod

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AuthMethod

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AuthMethod

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for AuthMethod

impl IntoV1 for AuthMethod

type Output = AuthMethod

The corresponding v1 type.

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

Converts this value into the corresponding v1 type.

impl JsonSchema for AuthMethod

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 AuthMethod

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

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 AuthMethod