Struct AuthEnvVar 

#[non_exhaustive]
pub struct AuthEnvVar {
    pub name: String,
    pub label: Option<String>,
    pub secret: bool,
    pub optional: bool,
    pub meta: Option<Map<String, Value>>,
}

UNSTABLE

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

Describes a single environment variable for an AuthMethodEnvVar authentication method.

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.

name: String

The environment variable name (e.g. "OPENAI_API_KEY").

label: Option<String>

Human-readable label for this variable, displayed in client UI.

secret: bool

Whether this value is a secret (e.g. API key, token). Clients should use a password-style input for secret vars.

Defaults to true.

optional: bool

Whether this variable is optional.

Defaults to false.

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 AuthEnvVar

pub fn new(name: impl Into<String>) -> AuthEnvVar

Available on crate feature unstable_auth_methods only.

Creates a new auth env var.

pub fn label(self, label: impl IntoOption<String>) -> AuthEnvVar

Available on crate feature unstable_auth_methods only.

Human-readable label for this variable, displayed in client UI.

pub fn secret(self, secret: bool) -> AuthEnvVar

Available on crate feature unstable_auth_methods only.

Whether this value is a secret (e.g. API key, token). Clients should use a password-style input for secret vars.

pub fn optional(self, optional: bool) -> AuthEnvVar

Available on crate feature unstable_auth_methods only.

Whether this variable is optional.

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

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 AuthEnvVar

fn clone(&self) -> AuthEnvVar

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AuthEnvVar

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AuthEnvVar

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for AuthEnvVar

impl IntoV2 for AuthEnvVar

Available on crate feature unstable_auth_methods only.

type Output = AuthEnvVar

The corresponding v2 draft type.

fn into_v2( self, ) -> Result<<AuthEnvVar as IntoV2>::Output, ProtocolConversionError>

Converts this value into the corresponding v2 draft type.

impl JsonSchema for AuthEnvVar

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 AuthEnvVar

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

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 AuthEnvVar