Struct ProviderRef 

pub struct ProviderRef { /* private fields */ }

A nonempty model identifier paired with a credential-free provider selection. Construction validates the identifier; both fields are read-only.

use rig_core::providers::registry::ProviderRef;
let Ok(mut reference) = ProviderRef::parse("deepseek:deepseek-chat") else { return; };
reference.model.clear(); // the validated identifier is private

Provider data is also read-only, so credentials cannot be inserted afterwards:

use rig_core::providers::registry::ProviderRef;
let Ok(mut reference) = ProviderRef::parse("deepseek:deepseek-chat") else { return; };
reference.provider = reference.provider().clone();

Implementations

impl ProviderRef

pub fn registered( id: ProviderId, model: impl Into<String>, ) -> Result<Self, RefError>

A reference to a non-empty model on a registered selection. Returns RefError::EmptyModel for an empty identifier.

pub fn configured( config: ProviderConfig, model: impl Into<String>, ) -> Result<Self, RefError>

A reference to a non-empty model on an explicit configuration. Removes the credential: references are persistent recipes, and the host supplies credentials through config at construction time. The host stays fixed, even if it is a preset’s default. For Copilot, use a registered reference to follow the resolved token’s proxy endpoint, or configure the intended endpoint before creating this reference. Returns RefError::EmptyModel for an empty identifier.

pub fn provider(&self) -> &Provider

The credential-free provider recipe.

pub fn model(&self) -> &str

The non-empty model identifier.

pub fn parse(text: &str) -> Result<Self, RefError>

Parse vendor[/format]:model.

The first : separates the selection from the model, so a model identifier may contain : and / freely.

pub fn id(&self) -> Option<ProviderId>

The catalog selection this reference names, if its dialect is registered.

pub fn config(&self, api_key: impl Into<Secret>) -> ProviderConfig

The configuration to build from, credentialed with api_key: the registry’s preset, or the explicit configuration rehydrated.

impl ProviderRef

pub fn completion_model(&self) -> Result<DynModel<Completion>, EnvError>

Available on crate feature reqwest only.

A completion model for this reference, credentials from the environment, on the shared reqwest client. A registered selection reads every variable its dialect names; an explicit configuration keeps its host and options and reads only its vendor’s credential.

pub fn completion_model_with( &self, api_key: impl Into<Secret>, http: impl HttpClientExt + 'static, ) -> DynModel<Completion>

A completion model for this reference, credentialed with api_key, sending through http.

Trait Implementations

impl Clone for ProviderRef

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 ProviderRef

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ProviderRef

Deserialize strings as registered references and maps as explicit configurations. Requires a self-describing format and preserves configuration field errors.

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

Deserialize this value from the given Serde deserializer.

impl Display for ProviderRef

Display vendor/format:model for registered and configured references. This label omits hosts and options; use serialization to preserve them.

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

Formats the value using the given formatter.

impl FromStr for ProviderRef

type Err = RefError

The associated error which can be returned from parsing.

fn from_str(text: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for ProviderRef

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ProviderRef

Serialize registered references as canonical strings and configured references as {config, model} objects to preserve their hosts and options.

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ProviderRef