oasysdb 0.4.1

Fast embedded vector database with incremental HNSW indexing.
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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107

// Other error types.
use bincode::ErrorKind as BincodeError;
use sled::Error as SledError;
use std::error::Error as StandardError;
use std::io::Error as IOError;

#[cfg(feature = "py")]
use super::*;

#[cfg(feature = "py")]
use pyo3::exceptions::PyValueError;

/// A custom error type containing the error message.
#[derive(Debug)]
pub struct Error(String);

impl Error {
    /// Create a new error with the given message.
    pub fn new(message: &str) -> Self {
        message.into()
    }

    /// Returns the error message.
    pub fn message(&self) -> &str {
        &self.0
    }

    // Common collection errors.

    /// Creates error: The collection is not found.
    pub fn collection_not_found() -> Self {
        let message = "The collection is not found.";
        message.into()
    }

    /// Creates error when the collection record limit is reached.
    pub fn collection_limit() -> Self {
        let max = u32::MAX;
        let brief = "The collection limit is reached.";
        let detail = format!("The max number of records is {max}.");
        let message = format!("{brief} {detail}");
        message.into()
    }

    // Common record errors.

    /// Creates error when vector record is not found.
    pub fn record_not_found() -> Self {
        let message = "The vector record is not found.";
        message.into()
    }

    /// Creates error when getting vector with invalid dimension.
    pub fn invalid_dimension(found: usize, expected: usize) -> Self {
        let brief = "Invalid vector dimension.";
        let detail = format!("Expected {expected}, found {found}.");
        let message = format!("{brief} {detail}");
        message.into()
    }
}

// Quality of life conversions to Error type.

impl From<String> for Error {
    fn from(err: String) -> Self {
        Error(err)
    }
}

impl From<&str> for Error {
    fn from(err: &str) -> Self {
        Error(err.to_string())
    }
}

// Interoperability with other error types.

impl From<Box<dyn StandardError>> for Error {
    fn from(err: Box<dyn StandardError>) -> Self {
        Error(err.to_string())
    }
}

impl From<SledError> for Error {
    fn from(err: SledError) -> Self {
        Error(err.to_string())
    }
}

impl From<IOError> for Error {
    fn from(err: IOError) -> Self {
        Error(err.to_string())
    }
}

impl From<Box<BincodeError>> for Error {
    fn from(err: Box<BincodeError>) -> Self {
        Error(err.to_string())
    }
}

#[cfg(feature = "py")]
impl From<Error> for PyErr {
    fn from(err: Error) -> Self {
        PyErr::new::<PyValueError, String>(err.0)
    }
}