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
use std::io;
use crate::key::Key;
use crate::node_id::NodeMode;
use crate::version::Version;
use crate::{ItemId, LayerId};
/// The different set of errors that hannoy can encounter.
#[derive(Debug, thiserror::Error)]
pub enum Error {
/// An internal error mostly related to LMDB or encoding/decoding.
#[error(transparent)]
Heed(#[from] heed::Error),
/// IO error
#[error(transparent)]
Io(#[from] io::Error),
/// The user is trying to insert or search for a vector that is not of the right dimensions.
#[error("Invalid vector dimensions. Got {received} but expected {expected}")]
InvalidVecDimension {
/// The expected number of dimensions.
expected: usize,
/// The dimensions given by the user.
received: usize,
},
/// An internal error returned when hannoy cannot generate internal IDs.
#[error("Database full. Hannoy cannot generate enough internal IDs for your items")]
DatabaseFull,
/// The user tried to append an item in the database but the last inserted item
/// is highler or equal to this one.
#[error("Item cannot be appended into the database")]
InvalidItemAppend,
/// The user is trying to query a database with a distance that is not of the right type.
#[error("Invalid distance provided. Got {received} but expected {expected}")]
UnmatchingDistance {
/// The expected distance type.
expected: String,
/// The distance given by the user.
received: &'static str,
},
/// Hannoy is not able to find the metadata for a given index.
/// It is probably because the user forget to build the database.
#[error(
"Metadata are missing on index {0}, You must build your database before attempting to read it"
)]
MissingMetadata(u16),
/// The last time items in the database were updated, the [`crate::HannoyBuilder::build`] method wasn't called.
#[error("The graph has not been built after an update on index {0}")]
NeedBuild(u16),
/// Returned iff the `should_abort` function returned true.
#[error("The corresponding build process has been cancelled")]
BuildCancelled,
/// Internal error
#[error("Internal error: {mode}({item}) is missing in index `{index}`")]
MissingKey {
/// The index that caused the error
index: u16,
/// The kind of item that was being queried
mode: &'static str,
/// The item ID queried
item: ItemId,
/// The item's layer
layer: LayerId,
},
/// Cannot decode the key mode
#[error("Cannot decode key mode: `{mode:?}`")]
CannotDecodeKeyMode {
/// The mode that couldn't be decoded.
mode: NodeMode,
},
/// Unknown version
#[error("Unknown version: v{version}")]
UnknownVersion {
/// The version that is unknown.
version: Version,
},
}
impl Error {
pub(crate) fn missing_key(key: Key) -> Self {
Self::MissingKey {
index: key.index,
mode: match key.node.mode {
NodeMode::Item => "Item",
NodeMode::Links => "Links",
NodeMode::Metadata => "Metadata",
NodeMode::Updated => "Updated",
},
item: key.node.item,
layer: key.node.layer,
}
}
}