Skip to main content

PromptRegistry

Struct PromptRegistry 

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

A registry of named prompt templates for dynamic dispatch.

Mirrors ToolRegistry for prompts: it stores type-erased RustPrompt implementations keyed by name, caches each PromptDefinition at registration time, and renders them on demand, keeping the type-erasure machinery a private implementation detail.

Implementations§

Source§

impl PromptRegistry

Source

pub fn new() -> Self

Create an empty prompt registry.

Source

pub fn register<P: RustPrompt + 'static>(&mut self, prompt: P) -> &mut Self

Register a RustPrompt, replacing any existing prompt of the same name.

Returns &mut Self for chaining.

§Panics

Panics if the prompt’s JSON schema cannot be serialized. This indicates a bug in the prompt’s Params type. Use try_register for the non-panicking variant.

Source

pub fn try_register<P: RustPrompt + 'static>( &mut self, prompt: P, ) -> Result<&mut Self, ToolError>

Register a RustPrompt, returning an error instead of panicking if the prompt’s JSON schema cannot be built.

This is the fallible counterpart to register. If a prompt with the same name was already registered, it is replaced.

§Errors

Returns ToolError if the prompt’s Params type fails to produce a JSON schema.

Source

pub fn with_prompt<P: RustPrompt + 'static>(self, prompt: P) -> Self

Register a RustPrompt, consuming and returning Self for chaining.

§Panics

Panics if the prompt’s JSON schema cannot be serialized; see register.

Source

pub fn definitions(&self) -> Vec<PromptDefinition>

Collect PromptDefinitions for all registered prompts.

Returns clones of the cached definitions computed at registration time.

Source

pub fn len(&self) -> usize

Number of registered prompts.

Source

pub fn is_empty(&self) -> bool

Whether the registry has no registered prompts.

Source

pub fn contains(&self, name: &str) -> bool

Whether a prompt with the given name is registered.

Source

pub fn definition(&self, name: &str) -> Option<&PromptDefinition>

Borrow the cached PromptDefinition for a registered prompt by name.

Returns None if no prompt named name is registered. Unlike definitions, this clones nothing.

Source

pub fn iter(&self) -> PromptDefinitions<'_>

Iterate over (name, definition) pairs for every registered prompt.

Yields clones of the cached definitions computed at registration time.

Source

pub async fn render( &self, name: &str, args: Value, ) -> Result<PromptOutput, ToolError>

Render a registered prompt by name with raw JSON arguments.

§Errors

Returns ToolError::not_found if no prompt named name is registered (carrying error_kind = "not_registered" metadata), or a render error if argument deserialization or rendering fails.

Trait Implementations§

Source§

impl Debug for PromptRegistry

Source§

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

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

impl Default for PromptRegistry

Source§

fn default() -> PromptRegistry

Returns the “default value” for a type. Read more
Source§

impl<'a> IntoIterator for &'a PromptRegistry

Iterate over (name, definition) pairs for every registered prompt.

Source§

type Item = (&'static str, PromptDefinition)

The type of the elements being iterated over.
Source§

type IntoIter = PromptDefinitions<'a>

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. 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> 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, 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