Struct LogoutAuthRequest 

#[non_exhaustive]
pub struct LogoutAuthRequest {
    pub meta: Option<Map<String, Value>>,
}

Available on crate feature unstable_protocol_v2 only.

Request parameters for the auth/logout method.

Terminates the current authenticated session.

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.

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 LogoutAuthRequest

pub fn new() -> LogoutAuthRequest

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

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

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 LogoutAuthRequest

fn clone(&self) -> LogoutAuthRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LogoutAuthRequest

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

Formats the value using the given formatter.

impl Default for LogoutAuthRequest

fn default() -> LogoutAuthRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for LogoutAuthRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for LogoutAuthRequest

impl JsonRpcMessage for LogoutAuthRequest

fn matches_method(method: &str) -> bool

Check if this message type matches the given method name.

fn method(&self) -> &str

The method name for the message.

fn to_untyped_message(&self) -> Result<UntypedMessage, Error>

Convert this message into an untyped message.

fn parse_message(method: &str, params: &impl Serialize) -> Result<Self, Error>

Parse this type from a method name and parameters.

impl JsonRpcRequest for LogoutAuthRequest

type Response = LogoutAuthResponse

The type of data expected in response.

impl JsonSchema for LogoutAuthRequest

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 LogoutAuthRequest

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for LogoutAuthRequest

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 LogoutAuthRequest

impl TryFrom<LogoutAuthRequest> for LogoutRequest

type Error = ProtocolConversionError

The type returned in the event of a conversion error.

fn try_from( value: LogoutAuthRequest, ) -> Result<LogoutRequest, ProtocolConversionError>

Performs the conversion.

impl TryFrom<LogoutRequest> for LogoutAuthRequest

type Error = ProtocolConversionError

The type returned in the event of a conversion error.

fn try_from( value: LogoutRequest, ) -> Result<LogoutAuthRequest, ProtocolConversionError>

Performs the conversion.