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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
use crate::abi;
use bytes::BytesMut;
use fastly_shared::FastlyStatus;
#[derive(Debug, Eq, Hash, PartialEq)]
#[repr(transparent)]
pub struct DictionaryHandle {
handle: u32,
}
impl DictionaryHandle {
pub const INVALID: Self = DictionaryHandle {
handle: fastly_shared::INVALID_DICTIONARY_HANDLE,
};
pub fn open(name: &str) -> Result<Self, OpenError> {
use OpenError::*;
let mut handle = Self::INVALID;
unsafe { abi::fastly_dictionary::open(name.as_ptr(), name.len(), handle.as_u32_mut()) }
.result()
.map(|_| handle)
.map_err(|status| match status {
FastlyStatus::NONE => NameEmpty,
FastlyStatus::UNSUPPORTED => NameTooLong,
FastlyStatus::INVAL => NameInvalid,
FastlyStatus::BADF => DictionaryDoesNotExist,
_ => panic!("fastly_dictionary::open returned an unrecognized result"),
})
}
pub fn get(&self, key: &str, max_len: usize) -> Result<Option<String>, LookupError> {
if self.is_invalid() {
panic!("cannot lookup value with invalid dictionary handle");
}
let mut buf = BytesMut::with_capacity(max_len);
let mut nwritten = 0;
let status = unsafe {
abi::fastly_dictionary::get(
self.as_u32(),
key.as_ptr(),
key.len(),
buf.as_mut_ptr(),
buf.capacity(),
&mut nwritten,
)
};
match status.result().map(|_| nwritten) {
Ok(nwritten) => {
assert!(
nwritten <= buf.capacity(),
"fastly_dictionary::get wrote too many bytes"
);
unsafe {
buf.set_len(nwritten);
}
Ok(Some(
String::from_utf8(buf.to_vec()).expect("host returns valid UTF-8"),
))
}
Err(FastlyStatus::NONE) => Ok(None),
Err(FastlyStatus::ERROR) => Err(LookupError::Other),
Err(FastlyStatus::BADF) => Err(LookupError::DictionaryInvalid),
Err(FastlyStatus::INVAL) => Err(LookupError::KeyInvalid),
Err(FastlyStatus::UNSUPPORTED) => Err(LookupError::KeyTooLong),
Err(FastlyStatus::BUFLEN) => Err(LookupError::ValueTooLong),
Err(_) => panic!("fastly_dictionary::get returned an unrecognized result"),
}
}
pub fn contains(&self, key: &str) -> Result<bool, LookupError> {
use LookupError::*;
match self.get(key, 0) {
Ok(Some(_)) | Err(ValueTooLong) => Ok(true),
Ok(None) => Ok(false),
Err(e) => Err(e),
}
}
pub fn is_valid(&self) -> bool {
!self.is_invalid()
}
pub fn is_invalid(&self) -> bool {
self.handle == Self::INVALID.handle
}
pub(crate) fn as_u32(&self) -> u32 {
self.handle
}
pub(crate) fn as_u32_mut(&mut self) -> &mut u32 {
&mut self.handle
}
}
#[derive(Debug, thiserror::Error)]
pub enum OpenError {
#[error("dictionary could not be found")]
DictionaryDoesNotExist,
#[error("dictionary names cannot be empty")]
NameEmpty,
#[error("dictionary name too long")]
NameTooLong,
#[error("invalid dictionary name")]
NameInvalid,
}
#[derive(Debug, thiserror::Error)]
pub enum LookupError {
#[error("invalid dictionary")]
DictionaryInvalid,
#[error("invalid dictionary key")]
KeyInvalid,
#[error("dictionary keys must be shorter than 256 characters")]
KeyTooLong,
#[error("dictionary value was longer than the given buffer")]
ValueTooLong,
#[error("dictionary lookup failed")]
Other,
}