pub struct ProviderOptions(/* private fields */);Expand description
Typed options for several providers, one entry per provider key. Each wire reads only the entry named by its own provider. Equality and the serialized form are the entries’ sections. A deserialized entry has no typed options behind it, so its fields are sent as written: inserting the typed options again restores their refusal check.
An entry Self::set stores from options that do not serialize holds
the OptionsError instead of sections. It fails the encode of every
request that carries it, whichever provider the request goes to, and it
fails serializing this value, so the error is never dropped. Two failed
entries are equal when their errors read the same.
Implementations§
Source§impl ProviderOptions
impl ProviderOptions
Sourcepub fn new() -> ProviderOptions
pub fn new() -> ProviderOptions
No entry.
Sourcepub fn insert<P>(
&mut self,
options: &<P as ProviderExtension>::Options,
) -> Result<&mut ProviderOptions, OptionsError>where
P: ProviderExtension,
pub fn insert<P>(
&mut self,
options: &<P as ProviderExtension>::Options,
) -> Result<&mut ProviderOptions, OptionsError>where
P: ProviderExtension,
Store options as P’s entry, replacing any entry it had. Options
that write no field leave P with no entry.
§Errors
When options does not serialize to an object of object sections.
Sourcepub fn set<O>(self, options: O) -> ProviderOptionswhere
O: ExtensionOptions,
pub fn set<O>(self, options: O) -> ProviderOptionswhere
O: ExtensionOptions,
self with options as the entry of their provider,
ExtensionOptions::Ext, replacing any entry it had. Options that
write no field leave that provider with no entry.
It cannot fail: options that do not serialize to an object of object
sections are stored as a failed entry, which fails the encode of a
request that carries it with the OptionsError as the source.
Self::with reports the same error at once.
The entry is always stored under O::Ext’s key, the built-in
provider the options type belongs to. A third-party provider whose
extension reuses a built-in options type (say OpenAiOptions for an
OpenAI-compatible gateway) must store them with
Self::with::<P> instead, or its wire never reads them.
use rig_core::completion::ProviderOptions;
use rig_core::providers::openrouter::extension::{OpenRouterExt, OpenRouterOptions};
let options = ProviderOptions::new().set(OpenRouterOptions::new().session_id("s-1"));
assert!(options.contains::<OpenRouterExt>());Sourcepub fn with<P>(
self,
options: &<P as ProviderExtension>::Options,
) -> Result<ProviderOptions, OptionsError>where
P: ProviderExtension,
pub fn with<P>(
self,
options: &<P as ProviderExtension>::Options,
) -> Result<ProviderOptions, OptionsError>where
P: ProviderExtension,
Sourcepub fn get<P>(&self) -> Option<&Map<String, Value>>where
P: ProviderExtension,
pub fn get<P>(&self) -> Option<&Map<String, Value>>where
P: ProviderExtension,
P’s sections as the wire receives them, when it has an entry.
None for a failed entry (Self::set).
Sourcepub fn remove<P>(&mut self)where
P: ProviderExtension,
pub fn remove<P>(&mut self)where
P: ProviderExtension,
Remove P’s entry.
Sourcepub fn contains<P>(&self) -> boolwhere
P: ProviderExtension,
pub fn contains<P>(&self) -> boolwhere
P: ProviderExtension,
Whether P has an entry.
Sourcepub fn overlay(self, over: &ProviderOptions) -> ProviderOptions
pub fn overlay(self, over: &ProviderOptions) -> ProviderOptions
self with each entry of over in place of its own for the same
provider. An agent’s options overlaid with a run’s give the run’s
entry for every provider the run names.
Trait Implementations§
Source§impl Clone for ProviderOptions
impl Clone for ProviderOptions
Source§fn clone(&self) -> ProviderOptions
fn clone(&self) -> ProviderOptions
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read more