nodedb-fts 0.1.1

Shared full-text search engine for NodeDB — inverted index, BM25 scoring, analyzers, fuzzy matching
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

// SPDX-License-Identifier: Apache-2.0

//! Typed errors for segment I/O and validation.

use thiserror::Error;

/// All failure modes for reading or writing an FTS segment file.
#[derive(Debug, Error)]
#[non_exhaustive]
pub enum SegmentError {
    /// Magic bytes at offset 0..4 do not match `b"FTSS"`.
    #[error("bad segment magic: expected b\"FTSS\"")]
    BadMagic,

    /// The segment was written by an incompatible format version.
    #[error("unsupported segment version {found} (current: {expected})")]
    UnsupportedVersion { found: u16, expected: u16 },

    /// The footer CRC does not match the re-computed CRC of the preceding bytes.
    #[error("segment checksum mismatch: expected {expected:#010x}, actual {actual:#010x}")]
    ChecksumMismatch { expected: u32, actual: u32 },

    /// The file is shorter than the minimum valid segment size.
    #[error("segment data is truncated")]
    Truncated,

    /// A term exceeds the maximum encodable length (u16::MAX bytes).
    #[error("term length {term_len} exceeds maximum {max}")]
    TermTooLong { term_len: usize, max: usize },
}