faiss-next 0.6.0

Rust bindings for Faiss (Facebook AI Similarity Search)
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

use std::ffi::{CStr, NulError};
use std::io;

use faiss_next_sys;

#[derive(Debug, thiserror::Error)]
pub enum Error {
    #[error("Faiss native error (code={code}): {message}")]
    Native { code: i32, message: String },

    #[error("Invalid index description: {0}")]
    InvalidDescription(String),

    #[error("Index not trained")]
    NotTrained,

    #[error("Index is empty")]
    EmptyIndex,

    #[error("Invalid dimension: expected {expected}, got {actual}")]
    InvalidDimension { expected: usize, actual: usize },

    #[error("Invalid parameter: {0}")]
    InvalidParameter(String),

    #[error("Invalid cast to {target}: {reason}")]
    InvalidCast {
        target: &'static str,
        reason: String,
    },

    #[error("Null pointer encountered")]
    NullPointer,

    #[error("Index does not support operation: {0}")]
    UnsupportedOperation(&'static str),

    #[error("IO error: {0}")]
    Io(#[from] io::Error),

    #[error("UTF-8 error: {0}")]
    Utf8(#[from] NulError),
}

pub type Result<T> = std::result::Result<T, Error>;

#[inline]
pub(crate) fn check_return_code(code: i32) -> Result<()> {
    if code == faiss_next_sys::FAISS_OK {
        return Ok(());
    }

    let message = unsafe {
        let ptr = faiss_next_sys::faiss_get_last_error();
        if ptr.is_null() {
            "unknown error".to_string()
        } else {
            CStr::from_ptr(ptr)
                .to_str()
                .unwrap_or("invalid error message")
                .to_string()
        }
    };

    Err(Error::Native { code, message })
}

impl Error {
    pub fn native(code: i32, message: impl Into<String>) -> Self {
        Error::Native {
            code,
            message: message.into(),
        }
    }

    pub fn invalid_cast(target: &'static str, reason: impl Into<String>) -> Self {
        Error::InvalidCast {
            target,
            reason: reason.into(),
        }
    }

    pub fn unsupported(operation: &'static str) -> Self {
        Error::UnsupportedOperation(operation)
    }
}