Struct ElicitResult 

#[non_exhaustive]
pub struct ElicitResult {
    pub action: ElicitationAction,
    pub content: Option<Value>,
    pub meta: Option<MetaObject>,
}

The result returned by a client in response to an elicitation request.

Contains the user’s decision (accept/decline/cancel) and optionally their input data if they chose to accept the request.

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.

action: ElicitationAction

The user’s decision on how to handle the elicitation request

content: Option<Value>

The actual data provided by the user, if they accepted the request. Must conform to the JSON schema specified in the original request. Only present when action is Accept.

meta: Option<MetaObject>

Optional protocol-level metadata for this result.

Implementations

impl ElicitResult

pub fn new(action: ElicitationAction) -> ElicitResult

Create a new ElicitResult.

pub fn with_content(self, content: Value) -> ElicitResult

Set the content on this result.

pub fn with_meta(self, meta: MetaObject) -> ElicitResult

Set the metadata on this result.

Trait Implementations

impl Clone for ElicitResult

fn clone(&self) -> ElicitResult

Returns a duplicate of the value.

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 ServerResult

fn from(value: ElicitResult) -> ServerResult

Converts to this type from the input type.

impl JsonSchema for ElicitResult

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 ElicitResult

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

Equality operator ==.

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

Inequality operator !=.

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