Skip to main content

NoticeGuide

Struct NoticeGuide 

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

Notices waiting for the model, delivered before its next call.

Share one Arc<NoticeGuide>: register a clone on the loop with with_guide, keep the other to push from the host’s event loop. Delivery is append-only — one user turn at the end of the history.

Implementations§

Source§

impl NoticeGuide

Source

pub fn new() -> Arc<Self> ⓘ

Source

pub fn push(&self, text: impl Into<String>)

Queue a notice for the model’s next call.

Source

pub fn has_pending(&self) -> bool

Anything not yet shown to the model? A run that ends with notices still pending never gave the model the chance to read them.

Source

pub fn take_pending(&self) -> Vec<String>

Take what is still waiting (e.g. to use as the next run’s input).

Source

pub fn take_delivered(&self) -> Vec<String>

Take what the guide has delivered since the last call.

Trait Implementations§

Source§

impl Guide for NoticeGuide

Source§

fn id(&self) -> &GuideId

Source§

fn kind(&self) -> Execution

Source§

fn scope(&self) -> &GuideScope

Source§

fn apply<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _ctx: &'life1 mut Context, _w: &'life2 World, ) -> Pin<Box<dyn Future<Output = Result<(), GuideError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Called ONCE per session, at the start, before the first model call. Use for content that doesn’t change across iterations (profile, skills catalogue, static instructions).
Source§

fn apply_before_iter<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, ctx: &'life1 mut Context, _w: &'life2 World, ) -> Pin<Box<dyn Future<Output = Result<(), GuideError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Called BEFORE every model.complete() call within a session (default: no-op). Override to inject content that should adapt to the current conversation state — most useful for recall-style guides that want to re-query an external store based on the last user message. 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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