Struct GetPromptResult

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

The server’s response to a prompts/get request from the client.

JSON schema

{
 "description": "The server's response to a prompts/get request from the client.",
 "type": "object",
 "required": [
   "messages"
 ],
 "properties": {
   "_meta": {
     "description": "This result property is reserved by the protocol to allow clients and servers to attach additional metadata to their responses.",
     "type": "object",
     "additionalProperties": {}
   },
   "description": {
     "description": "An optional description for the prompt.",
     "type": "string"
   },
   "messages": {
     "type": "array",
     "items": {
       "$ref": "#/definitions/PromptMessage"
     }
   }
 }
}

Fields

description: Option<String>

An optional description for the prompt.

messages: Vec<PromptMessage>

meta: Option<Map<String, Value>>

This result property is reserved by the protocol to allow clients and servers to attach additional metadata to their responses.

Trait Implementations

impl Clone for GetPromptResult

fn clone(&self) -> GetPromptResult

Returns a copy 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

Formats the value using the given formatter.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<GetPromptResult> for MessageFromServer

fn from(value: GetPromptResult) -> Self

Converts to this type from the input type.

impl From<GetPromptResult> for ResultFromServer

fn from(value: GetPromptResult) -> Self

Converts to this type from the input type.

impl From<GetPromptResult> for ServerResult

fn from(value: GetPromptResult) -> Self

Converts to this type from the input type.

impl FromMessage<GetPromptResult> for ServerMessage

fn from_message( message: GetPromptResult, request_id: Option<RequestId>, ) -> Result<Self, JsonrpcErrorError>

impl Serialize for GetPromptResult

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToMessage<ServerMessage> for GetPromptResult

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

impl TryFrom<ResultFromServer> for GetPromptResult

type Error = JsonrpcErrorError

The type returned in the event of a conversion error.

fn try_from(value: ResultFromServer) -> Result<Self, Self::Error>

Performs the conversion.