Struct AuthenticateParams

pub struct AuthenticateParams;

Triggers authentication on the agent side.

This method should only be called if the initialize response indicates the user isn’t already authenticated. If this succceeds then the client can send other messasges to the agent, If it fails then the error message should be shown and the user prompted to authenticate.

The implementation of authentication is left up to the agent, typically an oauth flow is run by opening a browser window in the background.

Trait Implementations

impl AgentRequest for AuthenticateParams

type Response = ()

fn into_any(self) -> AnyAgentRequest

fn response_from_any(any: AnyAgentResult) -> Result<Self::Response, Error>

impl Debug for AuthenticateParams

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AuthenticateParams

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for AuthenticateParams

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 Serialize for AuthenticateParams

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

where __S: Serializer,

Serialize this value into the given Serde serializer.