Enum ElicitationMode 

#[non_exhaustive]
pub enum ElicitationMode {
    Form(ElicitationFormMode),
    Url(ElicitationUrlMode),
}

Available on crate feature unstable_protocol_v2 only.

UNSTABLE

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

The mode of elicitation, determining how user input is collected.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Form(ElicitationFormMode)

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

Url(ElicitationUrlMode)

URL-based elicitation where the client directs the user to a URL.

Implementations

impl ElicitationMode

pub fn scope(&self) -> &ElicitationScope

Returns the scope this elicitation mode is tied to.

Trait Implementations

impl Clone for ElicitationMode

fn clone(&self) -> ElicitationMode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ElicitationMode

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ElicitationMode

fn deserialize<__D>( __deserializer: __D, ) -> Result<ElicitationMode, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ElicitationFormMode> for ElicitationMode

fn from(mode: ElicitationFormMode) -> ElicitationMode

Converts to this type from the input type.

impl From<ElicitationUrlMode> for ElicitationMode

fn from(mode: ElicitationUrlMode) -> ElicitationMode

Converts to this type from the input type.

impl IntoV1 for ElicitationMode

Available on crate feature unstable_elicitation only.

type Output = ElicitationMode

The corresponding v1 type.

fn into_v1( self, ) -> Result<<ElicitationMode as IntoV1>::Output, ProtocolConversionError>

Converts this value into the corresponding v1 type.

impl JsonSchema for ElicitationMode

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 ElicitationMode

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

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 ElicitationMode