Struct GetPromptRequestParams 

#[non_exhaustive]
pub struct GetPromptRequestParams {
    pub meta: Option<Meta>,
    pub name: String,
    pub arguments: Option<JsonObject>,
}

Parameters for retrieving a specific prompt

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<Meta>

Protocol-level metadata for this request (SEP-1319)

name: String

arguments: Option<JsonObject>

Implementations

impl GetPromptRequestParams

pub fn new(name: impl Into<String>) -> Self

Create a new GetPromptRequestParams with the given prompt name.

pub fn with_arguments(self, arguments: JsonObject) -> Self

Set the arguments for this prompt request.

pub fn with_meta(self, meta: Meta) -> Self

Set the metadata for this request.

Trait Implementations

impl Clone for GetPromptRequestParams

fn clone(&self) -> GetPromptRequestParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GetPromptRequestParams

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

Formats the value using the given formatter.

impl Default for GetPromptRequestParams

fn default() -> GetPromptRequestParams

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GetPromptRequestParams

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for GetPromptRequestParams

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 GetPromptRequestParams

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RequestParamsMeta for GetPromptRequestParams

fn meta(&self) -> Option<&Meta>

Get a reference to the meta field

fn meta_mut(&mut self) -> &mut Option<Meta>

Get a mutable reference to the meta field

fn set_meta(&mut self, meta: Meta)

Set the meta field

fn progress_token(&self) -> Option<ProgressToken>

Get the progress token from meta, if present

fn set_progress_token(&mut self, token: ProgressToken)

Set a progress token in meta

impl Serialize for GetPromptRequestParams

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for GetPromptRequestParams