Struct GetPromptResult 

pub struct GetPromptResult {
    pub description: Option<String>,
    pub messages: Vec<PromptMessage>,
    pub meta: Option<ResultMetaObject>,
    pub result_type: String,
}

The result returned by the server for a {@link GetPromptRequestprompts/get} request.

JSON schema

{
 "description": "The result returned by the server for a {@link GetPromptRequestprompts/get} request.",
 "type": "object",
 "required": [
   "messages",
   "resultType"
 ],
 "properties": {
   "_meta": {
     "$ref": "#/$defs/ResultMetaObject"
   },
   "description": {
     "description": "An optional description for the prompt.",
     "type": "string"
   },
   "messages": {
     "type": "array",
     "items": {
       "$ref": "#/$defs/PromptMessage"
     }
   },
   "resultType": {
     "description": "Indicates the type of the result, which allows the client to determine\nhow to parse the result object.\n\nServers implementing this protocol version MUST include this field.\nFor backward compatibility, when a client receives a result from a\nserver implementing an earlier protocol version (which does not include\nresultType), the client MUST treat the absent field as \"complete\".",
     "type": "string"
   }
 }
}

Fields

description: Option<String>

An optional description for the prompt.

messages: Vec<PromptMessage>

meta: Option<ResultMetaObject>

result_type: String

Indicates the type of the result, which allows the client to determine how to parse the result object. Servers implementing this protocol version MUST include this field. For backward compatibility, when a client receives a result from a server implementing an earlier protocol version (which does not include resultType), the client MUST treat the absent field as “complete”.

Trait Implementations

impl Clone for GetPromptResult

fn clone(&self) -> GetPromptResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GetPromptResult

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for GetPromptResult

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<GetPromptResult> for GetPromptResultResponseResult

fn from(value: GetPromptResult) -> GetPromptResultResponseResult

Converts to this type from the input type.

impl From<GetPromptResult> for ServerResult

fn from(value: GetPromptResult) -> ServerResult

Converts to this type from the input type.

impl From<GetPromptResult> for Result

fn from(value: GetPromptResult) -> Result

Converts to this type from the input type.

impl From<GetPromptResult> for MessageFromServer

fn from(value: GetPromptResult) -> MessageFromServer

Converts to this type from the input type.

impl Serialize for GetPromptResult

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 TryFrom<ServerResult> for GetPromptResult

type Error = RpcError

The type returned in the event of a conversion error.

fn try_from( value: ServerResult, ) -> Result<GetPromptResult, <GetPromptResult as TryFrom<ServerResult>>::Error>

Performs the conversion.