llama-crab 0.1.201

Safe, ergonomic and complete Rust bindings for llama.cpp
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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88

//! Error types for `llama-crab`.
//!
//! All fallible APIs return [`Result<T, LlamaError>`].

#![allow(clippy::module_inception)]

use thiserror::Error;

/// Result alias used throughout `llama-crab`.
pub type Result<T> = std::result::Result<T, LlamaError>;

/// Top-level error type for all `llama-crab` operations.
///
/// This enum is `#[non_exhaustive]` — new variants will be added in minor
/// releases as more features are exposed.
#[derive(Debug, Error)]
#[non_exhaustive]
pub enum LlamaError {
    /// Generic IO error.
    #[error("I/O: {0}")]
    Io(#[from] std::io::Error),

    /// Null byte inside a string passed to the C API.
    #[error("interior nul byte in string: {0}")]
    Nul(#[from] std::ffi::NulError),

    /// UTF-8 decoding failed.
    #[error("invalid utf-8: {0}")]
    Utf8(#[from] std::string::FromUtf8Error),

    /// UTF-8 conversion failed.
    #[error("invalid utf-8: {0}")]
    Utf8Lossy(#[from] std::str::Utf8Error),

    /// Failed to load a GGUF model.
    #[error("failed to load model: {0}")]
    ModelLoad(String),

    /// Failed to create a context.
    #[error("failed to create context: {0}")]
    ContextLoad(String),

    /// Decode failure (returned by `llama_decode`).
    #[error("decode failed (code {0})")]
    Decode(i32),

    /// Encode failure (returned by `llama_encode`).
    #[error("encode failed (code {0})")]
    Encode(i32),

    /// A batch operation overflowed or was invalid.
    #[error("batch error: {0}")]
    Batch(String),

    /// Embedding extraction failed.
    #[error("embedding error: {0}")]
    Embedding(String),

    /// Operation attempted without an initialized backend.
    #[error("backend not initialized")]
    BackendNotInitialized,

    /// JSON-schema → GBNF conversion failed.
    #[error("json schema to grammar: {0}")]
    JsonSchemaToGrammar(String),

    /// Chat template processing failed.
    #[error("chat template: {0}")]
    ChatTemplate(String),

    /// Generic catch-all for C-ABI FFI errors.
    #[error("C-ABI error (code {0})")]
    Ffi(i32),
}

impl LlamaError {
    /// Construct from a null pointer returned by a C function.
    #[must_use]
    pub fn null_return() -> Self {
        Self::Ffi(-1)
    }
}

impl From<std::num::TryFromIntError> for LlamaError {
    fn from(e: std::num::TryFromIntError) -> Self {
        Self::Batch(e.to_string())
    }
}