Struct Temperature 

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

Valid model temperature in the inclusive range 0.0..=2.0.

Implementations

impl Temperature

pub const MIN: f64 = 0.0

Lowest supported temperature.

pub const MAX: f64 = 2.0

Highest supported temperature.

pub fn new(value: f64) -> Result<Self, Error>

Creates a validated temperature.

Apple Intelligence accepts temperatures in the inclusive range Temperature::MIN through Temperature::MAX. Lower values make output more deterministic; higher values make output more varied.

Examples

use aimx::Temperature;

let temperature = Temperature::new(0.2)?;
assert_eq!(temperature.as_f64(), 0.2);

Errors

Returns Error::InvalidTemperature when value is outside 0.0..=2.0 or is NaN.

pub fn as_f64(self) -> f64

Returns the raw floating-point temperature.

Trait Implementations

impl Clone for Temperature

fn clone(&self) -> Temperature

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Temperature

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

Formats the value using the given formatter.

impl PartialEq for Temperature

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<f64> for Temperature

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: f64) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Temperature

impl StructuralPartialEq for Temperature