ElicitationRequest

Struct ElicitationRequest 

Source
pub struct ElicitationRequest { /* private fields */ }
Expand description

Ergonomic wrapper around protocol ElicitRequest with request ID

This type wraps the protocol-level ElicitRequest and adds the request ID from the JSON-RPC envelope. It provides ergonomic accessors while preserving full type safety from the protocol layer.

§Design Philosophy

Rather than duplicating protocol types, we wrap them. This ensures:

  • Type safety is preserved (ElicitationSchema stays typed!)
  • No data loss (Duration instead of lossy integer seconds)
  • Single source of truth (protocol crate defines MCP types)
  • Automatic sync (protocol changes propagate automatically)

§Examples

use turbomcp_client::handlers::ElicitationRequest;

async fn handle(request: ElicitationRequest) {
    // Access request ID
    println!("ID: {:?}", request.id());

    // Access message
    println!("Message: {}", request.message());

    // Access typed schema (not Value!)
    for (name, property) in &request.schema().properties {
        println!("Field: {}", name);
    }

    // Access timeout as Duration
    if let Some(timeout) = request.timeout() {
        println!("Timeout: {:?}", timeout);
    }
}

Implementations§

Source§

impl ElicitationRequest

Source

pub fn new(id: MessageId, request: ElicitRequest) -> Self

Create a new elicitation request wrapper

§Arguments
  • id - Request ID from JSON-RPC envelope
  • request - Protocol-level elicit request
Source

pub fn id(&self) -> &MessageId

Get request ID from JSON-RPC envelope

Source

pub fn message(&self) -> &str

Get human-readable message for the user

This is the primary prompt/question being asked of the user.

Source

pub fn schema(&self) -> &ElicitationSchema

Get schema defining expected response structure

Returns the typed ElicitationSchema which provides:

  • Type-safe access to properties
  • Required field information
  • Validation constraints
§Note

This returns a TYPED schema, not serde_json::Value. You can inspect the schema structure type-safely:

for (name, definition) in &request.schema().properties {
    match definition {
        PrimitiveSchemaDefinition::String { description, .. } => {
            println!("String field: {}", name);
        }
        PrimitiveSchemaDefinition::Number { minimum, maximum, .. } => {
            println!("Number field: {} ({:?}-{:?})", name, minimum, maximum);
        }
        _ => {}
    }
}
Source

pub fn timeout(&self) -> Option<Duration>

Get optional timeout as Duration

Converts milliseconds from the protocol to ergonomic Duration type. No data loss occurs (unlike converting to integer seconds).

Source

pub fn is_cancellable(&self) -> bool

Check if request can be cancelled by the user

Source

pub fn as_protocol(&self) -> &ElicitRequest

Get access to underlying protocol request if needed

For advanced use cases where you need the raw protocol type.

Source

pub fn into_protocol(self) -> ElicitRequest

Consume wrapper and return protocol request

Trait Implementations§

Source§

impl Clone for ElicitationRequest

Source§

fn clone(&self) -> ElicitationRequest

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ElicitationRequest

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more