Enum BrainError 

pub enum BrainError {
    Io(Error),
    Sqlite(Error),
    Json(Error),
    BrainNotFound {
        path: PathBuf,
    },
    InvalidBrain {
        path: PathBuf,
        reason: String,
    },
    SchemaVersion {
        found: u32,
        supported: u32,
    },
    MmapFormat(String),
    FtsQuery(String),
    FeatureDisabled(&'static str),
    Ast(String),
    Indexer(String),
    Bundle(String),
    Other(String),
}

Error type returned by all public rustbrain-core APIs.

Variants map roughly to subsystems: storage, mmap cache, FTS, indexing, and portable bundles. Display messages are stable enough for CLI stderr; the enum itself is not yet #[non_exhaustive] so minor releases may add variants carefully (consider matching with a wildcard in long-lived apps).

Variants

Io(Error)

Filesystem or OS I/O failure.

Sqlite(Error)

Underlying SQLite / rusqlite error (constraints, SQL, busy, etc.).

Json(Error)

JSON serialization or deserialization failure (bundles, markers, registry).

BrainNotFound

No .brain/db.sqlite at the expected path (call crate::Brain::create or sync first).

Fields

path: PathBuf

Path to the missing .brain directory (or parent).

InvalidBrain

.brain exists but is structurally invalid.

Fields

path: PathBuf

Path that failed validation.

reason: String

Human-readable reason.

SchemaVersion

On-disk schema is newer than this library build (upgrade rustbrain).

Fields

found: u32

Version found in schema_meta.

supported: u32

Maximum version this binary understands.

MmapFormat(String)

CSR graph.mmap magic/version/bounds validation failure.

FtsQuery(String)

Empty or illegal full-text query after sanitization.

FeatureDisabled(&'static str)

Called an API that requires a Cargo feature not enabled for this build.

Ast(String)

Tree-sitter / AST extraction failure.

Indexer(String)

Workspace walk / index pipeline failure.

Bundle(String)

Portable .brainbundle export or import failure.

Other(String)

Catch-all for rare internal conditions with a message.

Implementations

impl BrainError

pub fn other(msg: impl Into<String>) -> Self

Construct an BrainError::Other from any displayable message.

pub fn mmap(msg: impl Into<String>) -> Self

Construct an BrainError::MmapFormat from any displayable message.

pub fn indexer(msg: impl Into<String>) -> Self

Construct an BrainError::Indexer from any displayable message.

pub fn bundle(msg: impl Into<String>) -> Self

Construct an BrainError::Bundle from any displayable message.

Trait Implementations

impl Debug for BrainError

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

Formats the value using the given formatter.

impl Display for BrainError

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

Formats the value using the given formatter.

impl Error for BrainError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

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

Provides type-based access to context intended for error reports.

impl From<Error> for BrainError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for BrainError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for BrainError

fn from(source: Error) -> Self

Converts to this type from the input type.