Struct ElicitationFormMode 

#[non_exhaustive]
pub struct ElicitationFormMode {
    pub scope: ElicitationScope,
    pub requested_schema: ElicitationSchema,
}

Available on crate features unstable_elicitation and unstable_protocol_v2 only.

UNSTABLE

This capability is not part of the spec yet, and may be removed or changed at any point.

Form-based elicitation mode where the client renders a form from the provided schema.

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.

scope: ElicitationScope

The scope this elicitation is tied to.

requested_schema: ElicitationSchema

A JSON Schema describing the form fields to present to the user.

Implementations

impl ElicitationFormMode

pub fn new( scope: impl Into<ElicitationScope>, requested_schema: ElicitationSchema, ) -> Self

Trait Implementations

impl Clone for ElicitationFormMode

fn clone(&self) -> ElicitationFormMode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ElicitationFormMode

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ElicitationFormMode

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ElicitationFormMode> for ElicitationMode

fn from(mode: ElicitationFormMode) -> Self

Converts to this type from the input type.

impl IntoV1 for ElicitationFormMode

type Output = ElicitationFormMode

The corresponding v1 type.

fn into_v1(self) -> Result<Self::Output>

Converts this value into the corresponding v1 type.

impl JsonSchema for ElicitationFormMode

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 ElicitationFormMode

fn eq(&self, other: &ElicitationFormMode) -> 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 Serialize for ElicitationFormMode

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 ElicitationFormMode