Enum ReasoningSupport 

#[non_exhaustive]
pub enum ReasoningSupport {
    None,
    Unknown {
        default: Option<Effort>,
    },
    Listed {
        levels: Vec<Effort>,
        budget: Option<RangeInclusive<u32>>,
        can_disable: bool,
        default: Option<Effort>,
    },
}

The reasoning a model takes, in one of three states: it does not reason, it reasons but the catalog does not say which controls it takes, or it reasons and takes exactly the listed controls.

A catalog row that marks a model as reasoning but lists no reasoning options (most of them gateway rows on HuggingFace, OpenRouter, Venice and Bedrock) is Self::Unknown, which refuses nothing, as an empty CacheSupport does. Only a row whose hand-reviewed rig facts say "reasoning_control": "none" (a model whose API rejects every reasoning control) is Self::Listed with nothing listed.

use rig_core::catalog::ReasoningSupport;
use rig_core::completion::{Effort, Reasoning};

let unknown = ReasoningSupport::Unknown { default: None };
assert!(unknown.supported() && unknown.levels().is_none());
assert_eq!(unknown.refusal(&Reasoning::Effort(Effort::High)), None);

let listed = ReasoningSupport::Listed {
    levels: vec![Effort::Low, Effort::High],
    budget: None,
    can_disable: false,
    default: Some(Effort::High),
};
assert!(listed.refusal(&Reasoning::Off).is_some());
assert_eq!(listed.refusal(&Reasoning::Effort(Effort::Low)), None);

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

None

The model does not reason.

Unknown

The model reasons; the catalog does not say which controls it takes. Nothing is refused.

Fields

default: Option<Effort>

The effort it uses when a request names none, if documented.

Listed

The model reasons and takes exactly these controls.

Fields

levels: Vec<Effort>

The effort levels it takes, empty when it takes none.

budget: Option<RangeInclusive<u32>>

The reasoning-token budgets it takes, if it takes one.

can_disable: bool

Whether a request can turn its reasoning off.

default: Option<Effort>

The effort it uses when a request names none, if documented.

Implementations

impl ReasoningSupport

pub fn choices(&self) -> Vec<ReasoningChoice>

The reasoning settings the model takes: the provider default first, then off when reasoning can be turned off, then each effort level, or low, medium and high budgets on a model that takes a budget and no levels. A model whose controls the catalog does not list offers only the default.

pub fn named(&self, name: &str) -> Result<ReasoningChoice, UnknownReasoning>

The choice of Self::choices named name.

Errors

UnknownReasoning with the names there are, when none is name.

pub fn supported(&self) -> bool

Whether the model reasons at all.

pub fn levels(&self) -> Option<&[Effort]>

The effort levels the model takes: empty when it takes none (or does not reason), None when the catalog does not know, in which case a picker shows every level.

pub fn budget(&self) -> Option<&RangeInclusive<u32>>

The reasoning-token budgets the model takes, if the catalog lists one. None both when it takes no budget and when the catalog does not know; Self::levels tells the two apart.

pub fn can_disable(&self) -> Option<bool>

Whether a request can turn the model’s reasoning off: Some(false) for a model that does not reason, None when the catalog does not know.

pub fn default_effort(&self) -> Option<Effort>

The effort the model uses when a request names none, if documented.

pub fn refusal(&self, reasoning: &Reasoning) -> Option<String>

Why the model cannot take reasoning, or None when it can or the catalog does not know (Self::Unknown).

Trait Implementations

impl Clone for ReasoningSupport

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 ReasoningSupport

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

Formats the value using the given formatter.

impl Default for ReasoningSupport

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ReasoningSupport

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ReasoningSupport

impl PartialEq for ReasoningSupport

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ReasoningSupport

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ReasoningSupport