Struct ProviderOptions 

pub struct ProviderOptions(/* private fields */);

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

impl ProviderOptions

pub fn new() -> Self

No entry.

pub fn insert<P: ProviderExtension>( &mut self, options: &P::Options, ) -> Result<&mut Self, OptionsError>

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.

pub fn set<O: ExtensionOptions>(self, options: O) -> Self

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>());

pub fn with<P: ProviderExtension>( self, options: &P::Options, ) -> Result<Self, OptionsError>

self with options as P’s entry. See Self::insert.

Errors

As Self::insert.

pub fn get<P: ProviderExtension>(&self) -> Option<&Map<String, Value>>

P’s sections as the wire receives them, when it has an entry. None for a failed entry (Self::set).

pub fn remove<P: ProviderExtension>(&mut self)

Remove P’s entry.

pub fn contains<P: ProviderExtension>(&self) -> bool

Whether P has an entry.

pub fn is_empty(&self) -> bool

Whether no provider has an entry.

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

impl Clone for ProviderOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ProviderOptions

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

Formats the value using the given formatter.

impl Default for ProviderOptions

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ProviderOptions

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl PartialEq for ProviderOptions

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for ProviderOptions

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.