Struct ElicitRequest

pub struct ElicitRequest {
    pub params: ElicitRequestParams,
    /* private fields */
}

A request from the server to elicit additional information from the user via the client.

JSON schema

{
 "description": "A request from the server to elicit additional information from the user via the client.",
 "type": "object",
 "required": [
   "method",
   "params"
 ],
 "properties": {
   "method": {
     "type": "string",
     "const": "elicitation/create"
   },
   "params": {
     "type": "object",
     "required": [
       "message",
       "requestedSchema"
     ],
     "properties": {
       "message": {
         "description": "The message to present to the user.",
         "type": "string"
       },
       "requestedSchema": {
         "description": "A restricted subset of JSON Schema.\nOnly top-level properties are allowed, without nesting.",
         "type": "object",
         "required": [
           "properties",
           "type"
         ],
         "properties": {
           "properties": {
             "type": "object",
             "additionalProperties": {
               "$ref": "#/definitions/PrimitiveSchemaDefinition"
             }
           },
           "required": {
             "type": "array",
             "items": {
               "type": "string"
             }
           },
           "type": {
             "type": "string",
             "const": "object"
           }
         }
       }
     }
   }
 }
}

Fields

params: ElicitRequestParams

Implementations

impl ElicitRequest

pub fn new(params: ElicitRequestParams) -> ElicitRequest

pub fn method(&self) -> &String

pub fn method_name() -> String

Trait Implementations

impl Clone for ElicitRequest

fn clone(&self) -> ElicitRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ElicitRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ElicitRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ElicitRequest> for MessageFromServer

fn from(value: ElicitRequest) -> MessageFromServer

Converts to this type from the input type.

impl From<ElicitRequest> for RequestFromServer

fn from(value: ElicitRequest) -> RequestFromServer

Converts to this type from the input type.

impl From<ElicitRequest> for ServerRequest

fn from(value: ElicitRequest) -> ServerRequest

Converts to this type from the input type.

impl FromMessage<ElicitRequest> for ServerMessage

fn from_message( message: ElicitRequest, request_id: Option<RequestId>, ) -> Result<ServerMessage, RpcError>

impl Serialize for ElicitRequest

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 ToMessage<ServerMessage> for ElicitRequest

fn to_message( self, request_id: Option<RequestId>, ) -> Result<ServerMessage, RpcError>

impl TryFrom<RequestFromServer> for ElicitRequest

type Error = RpcError

The type returned in the event of a conversion error.

fn try_from( value: RequestFromServer, ) -> Result<ElicitRequest, <ElicitRequest as TryFrom<RequestFromServer>>::Error>

Performs the conversion.