scry-index 0.1.0

A concurrent sorted key-value map backed by learned index structures
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

//! Error types for scry-index.

use std::fmt;

/// Result type alias for scry-index operations.
pub type Result<T> = std::result::Result<T, Error>;

/// Errors that can occur during index operations.
#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[non_exhaustive]
pub enum Error {
    /// The input data is empty.
    EmptyData,
    /// The input data is not sorted.
    NotSorted,
    /// A key could not be converted to a model input.
    InvalidKey {
        /// Description of what went wrong.
        detail: String,
    },
}

impl fmt::Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::EmptyData => write!(f, "input data is empty"),
            Self::NotSorted => write!(f, "input data is not sorted"),
            Self::InvalidKey { detail } => write!(f, "invalid key: {detail}"),
        }
    }
}

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

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn error_display() {
        assert_eq!(Error::EmptyData.to_string(), "input data is empty");
        assert_eq!(Error::NotSorted.to_string(), "input data is not sorted");
        assert_eq!(
            Error::InvalidKey {
                detail: "overflow".into()
            }
            .to_string(),
            "invalid key: overflow"
        );
    }

    #[test]
    fn error_is_send_sync() {
        fn assert_send_sync<T: Send + Sync>() {}
        assert_send_sync::<Error>();
    }
}