Struct LoginAuthRequest 

#[non_exhaustive]
pub struct LoginAuthRequest {
    pub method_id: AuthMethodId,
    pub meta: Option<Meta>,
}

Available on crate feature unstable_protocol_v2 only.

Request parameters for the auth/login method.

Specifies which authentication method to use.

Agents MUST support this method when their initialize response advertised at least one valid authentication method. Clients MUST NOT call this method when authMethods was omitted or empty.

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.

method_id: AuthMethodId

The ID of the authentication method to use. Must be one of the methods advertised in the initialize response.

meta: Option<Meta>

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 LoginAuthRequest

pub fn new(method_id: impl Into<AuthMethodId>) -> Self

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

pub fn meta(self, meta: impl IntoOption<Meta>) -> Self

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 LoginAuthRequest

fn clone(&self) -> LoginAuthRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LoginAuthRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for LoginAuthRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for LoginAuthRequest

impl JsonSchema for LoginAuthRequest

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 LoginAuthRequest

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for LoginAuthRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for LoginAuthRequest

impl TryFrom<AuthenticateRequest> for LoginAuthRequest

type Error = ProtocolConversionError

The type returned in the event of a conversion error.

fn try_from(value: AuthenticateRequest) -> Result<Self>

Performs the conversion.

impl TryFrom<LoginAuthRequest> for AuthenticateRequest

type Error = ProtocolConversionError

The type returned in the event of a conversion error.

fn try_from(value: LoginAuthRequest) -> Result<Self>

Performs the conversion.