claw-core 0.1.2

Embedded local database engine for ClawDB — an agent-native cognitive database
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

//! Error types for claw-core.
//!
//! All public API errors are represented by [`ClawError`], a typed enum
//! backed by [`thiserror`]. Downstream crates should match on [`ClawError`]
//! variants rather than on the underlying error sources.

use thiserror::Error;

/// The unified error type for claw-core operations.
#[derive(Debug, Error)]
pub enum ClawError {
    /// An underlying SQLx database error occurred.
    #[error("database error: {0}")]
    Database(#[from] sqlx::Error),

    /// A migration step failed.
    #[error("migration error: {0}")]
    Migration(String),

    /// Configuration validation failed.
    #[error("configuration error: {0}")]
    Config(String),

    /// The requested record was not found.
    #[error("{entity} with id '{id}' not found")]
    NotFound {
        /// The entity type that was not found.
        entity: String,
        /// The identifier that was searched for.
        id: String,
    },

    /// A unique constraint violation occurred.
    #[error("{entity} with id '{id}' already exists")]
    Conflict {
        /// The entity type that already exists.
        entity: String,
        /// The conflicting identifier.
        id: String,
    },

    /// A serialization or deserialization error occurred.
    #[error("serialization error: {0}")]
    Serialization(#[from] serde_json::Error),

    /// A snapshot operation failed.
    #[error("snapshot error: {0}")]
    Snapshot(String),

    /// Snapshot checksum verification failed.
    #[error("snapshot corrupt: {0}")]
    SnapshotCorrupt(String),

    /// A transaction operation failed.
    #[error("transaction error: {0}")]
    Transaction(String),

    /// A cache operation failed.
    #[error("cache error: {0}")]
    Cache(String),

    /// The caller supplied invalid input.
    #[error("invalid input: {0}")]
    InvalidInput(String),

    /// An I/O error occurred (e.g. while managing snapshot files).
    #[error("I/O error: {0}")]
    IoError(#[from] std::io::Error),

    /// A store operation failed.
    #[error("store error: {0}")]
    Store(String),

    /// An index operation failed.
    #[error("index error: {0}")]
    Index(String),

    /// An unexpected internal error occurred.
    #[error("internal error: {0}")]
    Internal(String),
}

/// Convenience alias for `Result<T, ClawError>`.
pub type ClawResult<T> = Result<T, ClawError>;