Skip to main content

SystemLanguageModel

foundation_models::model

Struct SystemLanguageModel

pub struct SystemLanguageModel;

Expand description

The on-device default language model provided by the operating system.

FoundationModels exposes a single shared SystemLanguageModel.default; this type mirrors that singleton and only carries availability queries. To actually generate text, construct a crate::LanguageModelSession.

§Examples

use foundation_models::SystemLanguageModel;

if SystemLanguageModel::is_available() {
    println!("Apple Intelligence model is ready.");
} else {
    eprintln!("Unavailable: {:?}", SystemLanguageModel::availability());
}

Implementations§

impl SystemLanguageModel

pub fn is_available() -> bool

Convenience: availability() == Availability::Available.

pub fn availability() -> Availability

Detailed availability state of the on-device model.

Trait Implementations§

impl Clone for SystemLanguageModel

fn clone(&self) -> SystemLanguageModel

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

impl Debug for SystemLanguageModel

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

Formats the value using the given formatter. Read more

impl Copy for SystemLanguageModel

Auto Trait Implementations§

impl Freeze for SystemLanguageModel

impl RefUnwindSafe for SystemLanguageModel

impl Send for SystemLanguageModel

impl Sync for SystemLanguageModel

impl Unpin for SystemLanguageModel

impl UnsafeUnpin for SystemLanguageModel

impl UnwindSafe for SystemLanguageModel

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.