pub struct Brain { /* private fields */ }Expand description
The Brain wraps an LLM provider and adds higher-level logic: prompt construction, cost tracking, and model selection.
Implementations§
Source§impl Brain
impl Brain
pub fn new( provider: Arc<dyn LlmProvider>, system_prompt: impl Into<String>, ) -> Self
Sourcepub fn set_knowledge_addendum(&mut self, addendum: String)
pub fn set_knowledge_addendum(&mut self, addendum: String)
Set knowledge addendum (distilled rules) to append to the system prompt.
Sourcepub fn estimate_tokens(&self, messages: &[Message]) -> usize
pub fn estimate_tokens(&self, messages: &[Message]) -> usize
Estimate token count for messages using tiktoken-rs.
Sourcepub fn estimate_tokens_with_tools(
&self,
messages: &[Message],
tools: Option<&[ToolDefinition]>,
) -> usize
pub fn estimate_tokens_with_tools( &self, messages: &[Message], tools: Option<&[ToolDefinition]>, ) -> usize
Estimate token count for messages plus tool definitions.
Sourcepub fn build_messages(&self, conversation: &[Message]) -> Vec<Message>
pub fn build_messages(&self, conversation: &[Message]) -> Vec<Message>
Construct messages for the LLM with system prompt prepended.
If a knowledge addendum has been set via set_knowledge_addendum(),
it is automatically appended to the system prompt.
After assembly, sanitize_tool_sequence runs to ensure tool_call→tool_result
ordering is never broken regardless of compression, pinning, or system message injection.
Sourcepub async fn think(
&mut self,
conversation: &[Message],
tools: Option<Vec<ToolDefinition>>,
) -> Result<CompletionResponse, LlmError>
pub async fn think( &mut self, conversation: &[Message], tools: Option<Vec<ToolDefinition>>, ) -> Result<CompletionResponse, LlmError>
Send a completion request and return the response, tracking usage.
Sourcepub async fn think_with_retry(
&mut self,
conversation: &[Message],
tools: Option<Vec<ToolDefinition>>,
max_retries: usize,
) -> Result<CompletionResponse, LlmError>
pub async fn think_with_retry( &mut self, conversation: &[Message], tools: Option<Vec<ToolDefinition>>, max_retries: usize, ) -> Result<CompletionResponse, LlmError>
Send a completion request with retry logic and exponential backoff.
Retries on transient errors (RateLimited, Timeout, Connection) up to
max_retries times with exponential backoff (1s, 2s, 4s, …, capped at 32s).
Non-transient errors are returned immediately.
Sourcepub fn is_retryable(error: &LlmError) -> bool
pub fn is_retryable(error: &LlmError) -> bool
Check if an LLM error is transient and should be retried.
Sourcepub async fn think_streaming(
&mut self,
conversation: &[Message],
tools: Option<Vec<ToolDefinition>>,
tx: Sender<StreamEvent>,
) -> Result<(), LlmError>
pub async fn think_streaming( &mut self, conversation: &[Message], tools: Option<Vec<ToolDefinition>>, tx: Sender<StreamEvent>, ) -> Result<(), LlmError>
Send a streaming completion request, returning events via channel.
Sourcepub fn total_usage(&self) -> &TokenUsage
pub fn total_usage(&self) -> &TokenUsage
Get total token usage across all calls.
Sourcepub fn total_cost(&self) -> &CostEstimate
pub fn total_cost(&self) -> &CostEstimate
Get total cost across all calls.
Sourcepub fn model_name(&self) -> &str
pub fn model_name(&self) -> &str
Get the model name.
Sourcepub fn context_window(&self) -> usize
pub fn context_window(&self) -> usize
Get the context window size.
Sourcepub fn provider_cost_rates(&self) -> (f64, f64)
pub fn provider_cost_rates(&self) -> (f64, f64)
Get cost rates (input_per_token, output_per_token) from the provider.
Sourcepub fn provider(&self) -> &dyn LlmProvider
pub fn provider(&self) -> &dyn LlmProvider
Get a reference to the underlying LLM provider.
Sourcepub fn provider_arc(&self) -> Arc<dyn LlmProvider>
pub fn provider_arc(&self) -> Arc<dyn LlmProvider>
Get a cloneable Arc handle to the underlying LLM provider.
Sourcepub fn track_usage(&mut self, usage: &TokenUsage)
pub fn track_usage(&mut self, usage: &TokenUsage)
Track usage and cost from an external completion (e.g., streaming).
Sourcepub fn context_usage_ratio(&self, conversation: &[Message]) -> f32
pub fn context_usage_ratio(&self, conversation: &[Message]) -> f32
Get the current token usage as a fraction of the context window.
Auto Trait Implementations§
impl Freeze for Brain
impl !RefUnwindSafe for Brain
impl Send for Brain
impl Sync for Brain
impl Unpin for Brain
impl UnsafeUnpin for Brain
impl !UnwindSafe for Brain
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can
then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be
further downcast into Rc<ConcreteType> where ConcreteType implements Trait.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.Source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);