fm-bindings 0.1.5

Rust bindings for Apple's Foundation Models framework
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57

// Error types for Foundation Models bindings

use std::fmt;

/// Errors that can occur when using Foundation Models
#[derive(Debug, Clone)]
pub enum Error {
    /// The Foundation Model is not available on this system
    /// This typically means Apple Intelligence is not enabled
    ModelNotAvailable,

    /// The system returned an error during generation
    GenerationError(String),

    /// Invalid input was provided (e.g., empty prompt, null bytes)
    InvalidInput(String),

    /// An internal FFI error occurred
    InternalError(String),

    /// A mutex or synchronization primitive was poisoned
    /// This indicates a panic occurred while holding a lock
    PoisonError,
}

impl fmt::Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Error::ModelNotAvailable => {
                write!(
                    f,
                    "Foundation Model not available. Enable Apple Intelligence in System Settings."
                )
            }
            Error::GenerationError(msg) => {
                write!(f, "Generation error: {}", msg)
            }
            Error::InvalidInput(msg) => {
                write!(f, "Invalid input: {}", msg)
            }
            Error::InternalError(msg) => {
                write!(f, "Internal error: {}", msg)
            }
            Error::PoisonError => {
                write!(
                    f,
                    "Synchronization primitive poisoned due to panic while holding lock"
                )
            }
        }
    }
}

impl std::error::Error for Error {}

/// Result type alias for Foundation Models operations
pub type Result<T> = std::result::Result<T, Error>;