sourisdb 0.2.1

Database format focused on compression size without using external libraries.
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

//! `sourisdb` is a crate designed to provide a size-optimised way of transmitting a key-value store. There are a variety of methods used to achieve this goal ranging from variable-size integers to niche optimisations all detailed within [`values::Value`].
//!
//! The expected use-case is for web - in testing I've found this to be far more efficient than JSON whilst preserving type information AND providing additional types. Typically, `SourisDB` stores take around 25% less space than JSON objects even when minified.
//!
//! `sourisdb` can also be used for storage on-disk as it is entirely byte-order-agnostic as it deliberately stores everything using little-endian bytes.

#![cfg_attr(not(feature = "std"), no_std)]
// #![warn(missing_docs)]
#![warn(clippy::all, clippy::pedantic)]
#![allow(clippy::module_name_repetitions)]

extern crate alloc;
extern crate core;

use alloc::{
    format,
    string::{String, ToString},
};

pub use chrono;
pub use chrono_tz;
pub use hashbrown;
pub use serde_json;

pub mod store;
pub mod types;
pub mod utilities;
pub mod values;

//TODO: CommonSerError for common serialisation failures

#[cfg(feature = "axum")]
pub mod axum;

#[cfg(any(feature = "sync_client", feature = "async_client"))]
pub mod client;

#[must_use]
pub fn display_bytes_as_hex_array(b: &[u8]) -> String {
    let mut out;
    match b.len() {
        0 => out = "[]".to_string(),
        1 => out = format!("[{:#X}]", b[0]),
        _ => {
            out = format!("[{:#X}", b[0]);
            for b in b.iter().skip(1) {
                out.push_str(&format!(", {b:#X}"));
            }
            out.push(']');
        }
    };
    out
}