Struct ElicitResult

pub struct ElicitResult {
    pub action: ElicitResultAction,
    pub content: Option<HashMap<String, ElicitResultContentValue>>,
    pub meta: Option<Map<String, Value>>,
}

The client’s response to an elicitation request.

JSON schema

{
 "description": "The client's response to an elicitation request.",
 "type": "object",
 "required": [
   "action"
 ],
 "properties": {
   "_meta": {
     "description": "See [specification/2025-06-18/basic/index#general-fields] for notes on _meta usage.",
     "type": "object",
     "additionalProperties": {}
   },
   "action": {
     "description": "The user action in response to the elicitation.\n- \"accept\": User submitted the form/confirmed the action\n- \"decline\": User explicitly declined the action\n- \"cancel\": User dismissed without making an explicit choice",
     "type": "string",
     "enum": [
       "accept",
       "cancel",
       "decline"
     ]
   },
   "content": {
     "description": "The submitted form data, only present when action is \"accept\".\nContains values matching the requested schema.",
     "type": "object",
     "additionalProperties": {
       "type": [
         "string",
         "integer",
         "boolean"
       ]
     }
   }
 }
}

Fields

action: ElicitResultAction

The user action in response to the elicitation. - “accept”: User submitted the form/confirmed the action - “decline”: User explicitly declined the action - “cancel”: User dismissed without making an explicit choice

content: Option<HashMap<String, ElicitResultContentValue>>

The submitted form data, only present when action is “accept”. Contains values matching the requested schema.

meta: Option<Map<String, Value>>

See [specification/2025-06-18/basic/index#general-fields] for notes on _meta usage.

Trait Implementations

impl Clone for ElicitResult

fn clone(&self) -> ElicitResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ElicitResult

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ElicitResult

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ElicitResult> for ClientResult

fn from(value: ElicitResult) -> ClientResult

Converts to this type from the input type.

impl From<ElicitResult> for MessageFromClient

fn from(value: ElicitResult) -> MessageFromClient

Converts to this type from the input type.

impl From<ElicitResult> for ResultFromClient

fn from(value: ElicitResult) -> ResultFromClient

Converts to this type from the input type.

impl FromMessage<ElicitResult> for ClientMessage

fn from_message( message: ElicitResult, request_id: Option<RequestId>, ) -> Result<ClientMessage, RpcError>

impl Serialize for ElicitResult

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<ClientMessage> for ElicitResult

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

impl TryFrom<ResultFromClient> for ElicitResult

type Error = RpcError

The type returned in the event of a conversion error.

fn try_from( value: ResultFromClient, ) -> Result<ElicitResult, <ElicitResult as TryFrom<ResultFromClient>>::Error>

Performs the conversion.