Skip to main content

Prompt

Struct Prompt 

Source
pub struct Prompt {
    pub name: String,
    pub title: Option<String>,
    pub description: Option<String>,
    pub icons: Option<Vec<ToolIcon>>,
    pub arguments: Vec<PromptArgument>,
    /* private fields */
}
Expand description

A complete prompt definition with handler

Fields§

§name: String§title: Option<String>§description: Option<String>§icons: Option<Vec<ToolIcon>>§arguments: Vec<PromptArgument>

Implementations§

Source§

impl Prompt

Source

pub fn builder(name: impl Into<String>) -> PromptBuilder

Create a new prompt builder

Source

pub fn definition(&self) -> PromptDefinition

Get the prompt definition for prompts/list

Source

pub fn get( &self, arguments: HashMap<String, String>, ) -> BoxFuture<'_, Result<GetPromptResult>>

Get the prompt with arguments

Source

pub fn get_with_context( &self, ctx: RequestContext, arguments: HashMap<String, String>, ) -> BoxFuture<'_, Result<GetPromptResult>>

Get the prompt with request context

Use this when you have a RequestContext available for progress/cancellation.

Source

pub fn uses_context(&self) -> bool

Returns true if this prompt uses context

Trait Implementations§

Source§

impl Clone for Prompt

Source§

fn clone(&self) -> Self

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 Prompt

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Filterable for Prompt

Source§

fn name(&self) -> &str

Returns the name of this capability.

Auto Trait Implementations§

§

impl Freeze for Prompt

§

impl !RefUnwindSafe for Prompt

§

impl Send for Prompt

§

impl Sync for Prompt

§

impl Unpin for Prompt

§

impl !UnwindSafe for Prompt

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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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