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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
#![cfg(feature = "auto_encode_response")]
use std::borrow::Cow;
use std::future::Future;
use std::io::Write;
use std::pin::Pin;
use flate2::write::{GzEncoder,DeflateEncoder};
/// for providing encoding configurations for response data
#[derive(Debug)]
pub struct EncodingConfigurations {
pub(crate) logic:EncodingLogic,
/// - this framework support encoding with all encoding algorithms
/// ['zstd,Gzip,Deflate,Brotli'] so the response will be compressed with one of these
/// algorithms depending on the threshold of the data you need to send
/// so the default value is 4000000 which is approximately [4 MB ]
/// so if your server is very close to your clients leave this value as default but
/// if your server is a little far from your client then try to decrease this threshold
/// to get the best response latency
/// also notice that when you send a custom headers you should implement this encoding manually
pub threshold_for_encoding_response:usize,
}
impl EncodingConfigurations {
#[inline]
pub (crate) fn is_not_none(&self)->bool {self.logic.is_not_none()}
/// creating new [EncodingConfigurations] with default values
/// logic : [EncodingLogic::None]
/// threshold: 4_000_000
pub fn default()->Self{
EncodingConfigurations {
logic:EncodingLogic::None,
threshold_for_encoding_response:4_000_000
}
}
/// for setting new logic [EncodingLogic]
pub fn set_logic(&mut self,logic:EncodingLogic){
self.logic = logic;
}
/// for setting new threshold
pub fn set_threshold(&mut self,max:usize){
self.threshold_for_encoding_response = max;
}
pub (crate) async fn encode(&self,accept_encoding:Cow<'_, str>,data:&[u8])->
Option<EncodedData> {
let accept_encoding = accept_encoding.to_lowercase();
match self.logic {
EncodingLogic::All => {return self.default_encode(accept_encoding,data).await}
EncodingLogic::Default => {return self.default_encode(accept_encoding,data).await}
EncodingLogic::Zstd => {
if accept_encoding.contains("zstd") {
let data = zstd_encode(data);
if let Some(data) = data {
return Some(
EncodedData::new(
EncodingLogic::Zstd,
data
)
)
}
}
}
EncodingLogic::Brotli => {
if accept_encoding.contains("br") {
let data = brotli_encode(data);
if let Some(data) = data {
return Some(
EncodedData::new(
EncodingLogic::Brotli,
data
)
)
}
}
}
EncodingLogic::Gzip => {
if accept_encoding.contains("gzip") {
let data = gzip_encode(data);
if let Some(data) = data {
return Some(
EncodedData::new(
EncodingLogic::Gzip,
data
)
)
}
}
}
EncodingLogic::Deflate => {
if accept_encoding.contains("deflate") {
let data = deflate_encode(data);
if let Some(data) = data {
return Some(
EncodedData::new(
EncodingLogic::Default,
data
)
)
}
}
}
EncodingLogic::Lz4 => {
if accept_encoding.contains("lz4") {
let data = lz4_encode(data);
if let Some(data) = data {
return Some(
EncodedData::new(
EncodingLogic::Lz4,
data
)
)
}
}
}
EncodingLogic::Bzip2 => {
if accept_encoding.contains("bzip2") {
let data = b2zip_encode(data);
if let Some(data) = data {
return Some(
EncodedData::new(
EncodingLogic::Bzip2,
data
)
)
}
}
}
EncodingLogic::Snappy => {
if accept_encoding.contains("snappy") {
let data = b2zip_encode(data);
if let Some(data) = data {
return Some(
EncodedData::new(
EncodingLogic::Snappy,
data
)
)
}
}
}
EncodingLogic::None => {return None}
EncodingLogic::Custom(callback) => {
if let Ok(res) = callback(&accept_encoding,data).await {
return Some(res)
}
return None;
}
}
None
}
pub (crate) async fn default_encode(&self,accept_encoding:String,data:&[u8])->Option<EncodedData>{
let logic = match Self::pick_best_encoding(&accept_encoding) {
Some(d)=>{d}
_ => { return None}
};
match logic {
EncodingLogic::Zstd => {
if accept_encoding.contains("zstd") {
let data = zstd_encode(data);
if let Some(data) = data {
return Some(
EncodedData::new(
EncodingLogic::Zstd,
data
)
)
}
}
}
EncodingLogic::Brotli => {
if accept_encoding.contains("br") {
let data = brotli_encode(data);
if let Some(data) = data {
return Some(
EncodedData::new(
EncodingLogic::Brotli,
data
)
)
}
}
}
EncodingLogic::Gzip => {
if accept_encoding.contains("gzip") {
let data = gzip_encode(data);
if let Some(data) = data {
return Some(
EncodedData::new(
EncodingLogic::Gzip,
data
)
)
}
}
}
EncodingLogic::Deflate => {
if accept_encoding.contains("deflate") {
let data = deflate_encode(data);
if let Some(data) = data {
return Some(
EncodedData::new(
EncodingLogic::Default,
data
)
)
}
}
}
EncodingLogic::Lz4 => {
if accept_encoding.contains("lz4") {
let data = lz4_encode(data);
if let Some(data) = data {
return Some(
EncodedData::new(
EncodingLogic::Lz4,
data
)
)
}
}
}
EncodingLogic::Bzip2 => {
if accept_encoding.contains("bzip2") {
let data = b2zip_encode(data);
if let Some(data) = data {
return Some(
EncodedData::new(
EncodingLogic::Bzip2,
data
)
)
}
}
}
EncodingLogic::Snappy => {
if accept_encoding.contains("snappy") {
let data = snappy_encode(data);
if let Some(data) = data {
return Some(
EncodedData::new(
EncodingLogic::Snappy,
data
)
)
}
}
}
_ => {}
}
None
}
fn pick_best_encoding(header: &str) -> Option<EncodingLogic> {
let supported_encodings = vec!["br", "zstd", "gzip", "deflate", "lz4", "bzip2", "snappy"];
for encoding in supported_encodings {
if header.contains(encoding) {
return match encoding {
"br" => Some(EncodingLogic::Brotli),
"zstd" => Some(EncodingLogic::Zstd),
"gzip" => Some(EncodingLogic::Gzip),
"deflate" => Some(EncodingLogic::Deflate),
"lz4" => Some(EncodingLogic::Lz4),
"bzip2" => Some(EncodingLogic::Bzip2),
"snappy" => Some(EncodingLogic::Snappy),
_ => None,
};
}
}
None
}
}
/// for encoding configurations
#[derive(Debug)]
pub enum EncodingLogic{
/// to support all encoding algorithms
All,
/// works as well as [`EncodingLogic::All`] option
Default,
/// for providing zstd encoding only
Zstd,
/// for providing brotli encoding only
Brotli,
/// for providing gzip encoding only
Gzip,
/// for providing deflate encoding only
Deflate,
/// for providing Snappy encoding only
Snappy,
/// for providing Bzip2 encoding only
Bzip2,
/// for providing Lz4 encoding only
Lz4,
/// to never encode response
None,
/// when custom creating encoding logic
Custom(fn (&str,&[u8])->Pin<Box<dyn Future<Output=Result<EncodedData,()>> + Send>>)
}
impl EncodingLogic {
#[inline]
pub (crate) fn is_not_none(&self)->bool{
if let EncodingLogic::None = self {return false}
return true
}
pub (crate) fn content_encoding(&self)->Option<&str>{
match self {
EncodingLogic::Zstd => {Some("zstd")}
EncodingLogic::Brotli => {Some("br")}
EncodingLogic::Gzip => {Some("gzip")}
EncodingLogic::Deflate => {Some("deflate")}
EncodingLogic::Snappy => {Some("snappy")}
EncodingLogic::Bzip2 => {Some("bzip2")}
EncodingLogic::Lz4 => {Some("lz4")}
_ =>{None}
}
}
}
/// for providing encoding generic use cases
pub struct EncodedData {
pub(crate) logic:String,
pub(crate) data:Vec<u8>
}
impl EncodedData {
pub (crate) fn new(logic:EncodingLogic,data:Vec<u8>)->Self{
Self {
logic:logic.content_encoding().unwrap_or("").to_owned(),
data
}
}
}
unsafe impl Send for EncodedData {}
unsafe impl Send for EncodingLogic {}
unsafe impl Send for EncodingConfigurations {}
fn gzip_encode(data:&[u8])->Option<Vec<u8>>{
let mut encoder = GzEncoder::new(Vec::new(),flate2::Compression::best());
if encoder.write_all(data).is_err() {return None;}
if let Ok(res) = encoder.finish() { return Some(res)}
None
}
fn deflate_encode(data:&[u8])->Option<Vec<u8>>{
let mut encoder = DeflateEncoder::new(Vec::new(),flate2::Compression::best());
if encoder.write_all(data).is_err() {return None;}
if let Ok(res) = encoder.finish() { return Some(res)}
None
}
fn zstd_encode(data:&[u8])->Option<Vec<u8>>{
let mut encoder =
match zstd::stream::Encoder::new(Vec::new(),3) {
Ok(r) => {r}
Err(_) => { return None}
};
if encoder.write_all(data).is_err() {return None}
if let Ok(res) = encoder.finish() {
return Some(res)
}
None
}
fn brotli_encode(data:&[u8])->Option<Vec<u8>>{
let mut encoder = brotli::CompressorWriter::new(Vec::new(), 4096, 5, 22);
if encoder.write_all(data).is_err() {return None}
Some(encoder.into_inner())
}
fn snappy_encode(data:&[u8])->Option<Vec<u8>> {
let mut encoder = snap::write::FrameEncoder::new(Vec::new());
if encoder.write_all(data).is_err() { return None}
if let Ok(res) = encoder.into_inner() {
return Some(res)
}
return None;
}
fn lz4_encode(data: &[u8]) -> Option<Vec<u8>> {
let mut encoder = lz4::EncoderBuilder::new().build(Vec::new()).expect("Failed to create LZ4 encoder");
if let Err(_) = encoder.write_all(data) { return None}
let (compressed, result) = encoder.finish();
if let Err(_) = result { return None}
Some(compressed)
}
fn b2zip_encode(data:&[u8])->Option<Vec<u8>>{
let mut encoder = bzip2::write::BzEncoder::new(Vec::new(),bzip2::Compression::best());
if encoder.write_all(data).is_err() { return None}
if let Ok(res) = encoder.finish() {
return Some(res);
}
None
}