Struct GetPromptRequestParams 

#[non_exhaustive]
pub struct GetPromptRequestParams {
    pub meta: Option<RequestMetaObject>,
    pub name: String,
    pub arguments: Option<JsonObject>,
    pub input_responses: Option<InputResponses>,
    pub request_state: Option<String>,
}

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

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

name: String

arguments: Option<JsonObject>

input_responses: Option<InputResponses>

Client responses to server-initiated input requests from a previous InputRequiredResult.

request_state: Option<String>

Opaque request state echoed back from a previous InputRequiredResult.

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: RequestMetaObject) -> Self

Set the metadata for this request.

pub fn with_input_responses(self, input_responses: InputResponses) -> Self

Sets the input responses for an MRTR retry.

pub fn with_request_state(self, request_state: impl Into<String>) -> Self

Sets the request state for an MRTR retry.

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

Available on crate feature schemars only.

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

Equality operator ==.

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

Inequality operator !=.

impl RequestParamsMeta for GetPromptRequestParams

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

Get a reference to the meta field

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

Get a mutable reference to the meta field

fn set_meta(&mut self, meta: RequestMetaObject)

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

fn traceparent(&self) -> Option<&str>

Get the W3C traceparent value from meta, if present (SEP-414)

fn set_traceparent(&mut self, value: &str)

Set the W3C traceparent value in meta (SEP-414)

fn tracestate(&self) -> Option<&str>

Get the W3C tracestate value from meta, if present (SEP-414)

fn set_tracestate(&mut self, value: &str)

Set the W3C tracestate value in meta (SEP-414)

fn baggage(&self) -> Option<&str>

Get the W3C baggage value from meta, if present (SEP-414)

fn set_baggage(&mut self, value: &str)

Set the W3C baggage value in meta (SEP-414)

fn meta_or_default(&mut self) -> &mut RequestMetaObject

Get a mutable reference to meta, inserting an empty one if absent.

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