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 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500
use std::collections::HashMap;
use std::fmt::Debug;
use serde::{Deserialize, Deserializer, Serialize};
/// BinaryKV is how data is represented programmatically in the database.
///
/// It accepts any type that implements `Serialize` and `Deserialize` from the `serde` crate
/// and uses it for the value of the key-value pair.
/// ```rust
/// use quick_kv::prelude::*;
///
/// BinaryKv::new("key".to_string(), "value".to_string());
/// ```
/// This is the same as:
/// ```rust
/// use quick_kv::prelude::*;
///
/// let data = BinaryKv {
/// key: "key".to_string(),
/// value: "value".to_string(),
/// };
/// ```
#[derive(Serialize, PartialEq, Debug, Clone, Eq, Hash, PartialOrd)]
pub struct BinaryKv<T>
where
T: Serialize + Clone + Debug,
{
/// The key of the key-value pair
pub key: String,
/// The value of the key-value pair
pub value: T,
}
impl<T> BinaryKv<T>
where
T: Serialize + Clone + Debug,
{
pub fn new(key: String, value: T) -> Self
{
BinaryKv { key, value }
}
}
impl<'de, T> Deserialize<'de> for BinaryKv<T>
where
T: Deserialize<'de> + Serialize + Clone + Debug,
{
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where
D: Deserializer<'de>,
{
#[derive(Deserialize)]
struct ValueHelper<T>
{
key: String,
value: T,
}
let helper = ValueHelper::<T>::deserialize(deserializer)?;
Ok(BinaryKv {
key: helper.key,
value: helper.value,
})
}
}
/// Represents any type of data that can be stored in the database.
///
/// This can be any type of data that implements `Serialize` and `Deserialize` from the `serde`
/// crate.
#[derive(Serialize, Deserialize, PartialEq, Debug, Clone)]
pub enum Value
{
String(String),
Bool(bool),
U8(u8),
U16(u16),
U32(u32),
U64(u64),
U128(u128),
Usize(usize),
I8(i8),
I16(i16),
I32(i32),
I64(i64),
I128(i128),
Isize(isize),
F32(f32),
F64(f64),
None,
}
/// A util trait for converting a Value a usable type in rust.
/// ```rust
/// use quick_kv::prelude::*;
///
/// let five = Value::I32(5).into_i32();
/// ```
/// Keep in mind, that if you dont call `into_<type>` then you will get a `Value` type back as a type
/// but also not the right data.
/// ```rust
/// use quick_kv::prelude::*;
///
/// let is_not_really_five = Value::I32(5);
/// ```
pub trait IntoValue
{
fn into_value(self) -> Value;
fn into_string(self) -> String;
fn into_bool(self) -> bool;
fn into_u8(self) -> u8;
fn into_u16(self) -> u16;
fn into_u32(self) -> u32;
fn into_u64(self) -> u64;
fn into_u128(self) -> u128;
fn into_usize(self) -> usize;
fn into_i8(self) -> i8;
fn into_i16(self) -> i16;
fn into_i32(self) -> i32;
fn into_i64(self) -> i64;
fn into_i128(self) -> i128;
fn into_isize(self) -> isize;
fn into_f32(self) -> f32;
fn into_f64(self) -> f64;
}
impl IntoValue for Value
{
fn into_value(self) -> Value
{
self
}
fn into_string(self) -> String
{
match self {
Value::String(string) => string,
_ => panic!("Cannot convert Value to String"),
}
}
fn into_bool(self) -> bool
{
match self {
Value::Bool(bool) => bool,
_ => panic!("Cannot convert Value to bool"),
}
}
fn into_u8(self) -> u8
{
match self {
Value::U8(u8) => u8,
_ => panic!("Cannot convert Value to u8"),
}
}
fn into_u16(self) -> u16
{
match self {
Value::U16(u16) => u16,
_ => panic!("Cannot convert Value to u16"),
}
}
fn into_u32(self) -> u32
{
match self {
Value::U32(u32) => u32,
_ => panic!("Cannot convert Value to u32"),
}
}
fn into_u64(self) -> u64
{
match self {
Value::U64(u64) => u64,
_ => panic!("Cannot convert Value to u64"),
}
}
fn into_u128(self) -> u128
{
match self {
Value::U128(u128) => u128,
_ => panic!("Cannot convert Value to u128"),
}
}
fn into_usize(self) -> usize
{
match self {
Value::Usize(usize) => usize,
_ => panic!("Cannot convert Value to usize"),
}
}
fn into_i8(self) -> i8
{
match self {
Value::I8(i8) => i8,
_ => panic!("Cannot convert Value to i8"),
}
}
fn into_i16(self) -> i16
{
match self {
Value::I16(i16) => i16,
_ => panic!("Cannot convert Value to i16"),
}
}
fn into_i32(self) -> i32
{
match self {
Value::I32(i32) => i32,
_ => panic!("Cannot convert Value to i32"),
}
}
fn into_i64(self) -> i64
{
match self {
Value::I64(i64) => i64,
_ => panic!("Cannot convert Value to i64"),
}
}
fn into_i128(self) -> i128
{
match self {
Value::I128(i128) => i128,
_ => panic!("Cannot convert Value to i128"),
}
}
fn into_isize(self) -> isize
{
match self {
Value::Isize(isize) => isize,
_ => panic!("Cannot convert Value to isize"),
}
}
fn into_f32(self) -> f32
{
match self {
Value::F32(f32) => f32,
_ => panic!("Cannot convert Value to f32"),
}
}
fn into_f64(self) -> f64
{
match self {
Value::F64(f64) => f64,
_ => panic!("Cannot convert Value to f64"),
}
}
}
/// A util trait for converting a raw type into a Value
pub trait RawIntoValue
{
fn into_value(self) -> Value;
}
impl RawIntoValue for String
{
fn into_value(self) -> Value
{
Value::String(self)
}
}
impl RawIntoValue for bool
{
fn into_value(self) -> Value
{
Value::Bool(self)
}
}
impl RawIntoValue for u8
{
fn into_value(self) -> Value
{
Value::U8(self)
}
}
impl RawIntoValue for u16
{
fn into_value(self) -> Value
{
Value::U16(self)
}
}
impl RawIntoValue for u32
{
fn into_value(self) -> Value
{
Value::U32(self)
}
}
impl RawIntoValue for u64
{
fn into_value(self) -> Value
{
Value::U64(self)
}
}
impl RawIntoValue for u128
{
fn into_value(self) -> Value
{
Value::U128(self)
}
}
impl RawIntoValue for usize
{
fn into_value(self) -> Value
{
Value::Usize(self)
}
}
impl RawIntoValue for i8
{
fn into_value(self) -> Value
{
Value::I8(self)
}
}
impl RawIntoValue for i16
{
fn into_value(self) -> Value
{
Value::I16(self)
}
}
impl RawIntoValue for i32
{
fn into_value(self) -> Value
{
Value::I32(self)
}
}
impl RawIntoValue for i64
{
fn into_value(self) -> Value
{
Value::I64(self)
}
}
impl RawIntoValue for i128
{
fn into_value(self) -> Value
{
Value::I128(self)
}
}
impl RawIntoValue for isize
{
fn into_value(self) -> Value
{
Value::Isize(self)
}
}
impl RawIntoValue for f32
{
fn into_value(self) -> Value
{
Value::F32(self)
}
}
impl RawIntoValue for f64
{
fn into_value(self) -> Value
{
Value::F64(self)
}
}
/// Represents any type of data that can be stored in the database.
///
/// The only different between this and `Value` is that this is a generic type, and `Value` is not.
/// This type also only supports `Vec<T>`, `HashMap<String, T>`, and `Option<T>`.
/// ```rust
/// use quick_kv::prelude::*;
///
/// let mut list_of_people = vec!["Ray".to_string(), "Noa".to_string(), "Kian".to_string()];
///
/// let typed_value = TypedValue::<String>::Vec(list_of_people.clone());
/// ```
///
/// You can also convert a `TypedValue` into a `Vec<T>`, `HashMap<String, T>`, or `Option<T>`.
/// ```rust
/// use quick_kv::prelude::*;
///
/// let mut list_of_people = vec!["Ray".to_string(), "Noa".to_string(), "Kian".to_string()];
///
/// let typed_value_as_a_vec = TypedValue::<String>::Vec(list_of_people.clone()).into_vec();
/// ```
/// These are not really practical examples, but the TypedValue enum is useful when working with
/// the normal client and when needing to ensure type safety on data operations.
#[derive(Serialize, Deserialize, PartialEq, Debug, Clone)]
pub enum TypedValue<T>
{
Vec(Vec<T>),
Hash(HashMap<String, T>),
Option(Option<T>),
}
/// A util trait for converting a TypedValue a usable type in rust.
pub trait IntoTypedValue<T>
{
fn into_vec(self) -> Vec<T>;
fn into_hash(self) -> HashMap<String, T>;
fn into_option(self) -> Option<T>;
}
impl<T> IntoTypedValue<T> for TypedValue<T>
{
fn into_vec(self) -> Vec<T>
{
match self {
TypedValue::Vec(vec) => vec,
_ => panic!("Cannot convert TypedValue to Vec"),
}
}
fn into_hash(self) -> HashMap<String, T>
{
match self {
TypedValue::Hash(hash) => hash,
_ => panic!("Cannot convert TypedValue to HashMap"),
}
}
fn into_option(self) -> Option<T>
{
match self {
TypedValue::Option(option) => option,
_ => panic!("Cannot convert TypedValue to Option"),
}
}
}
/// A util trait for converting a raw type into a TypedValue
///
/// ```rust
/// use std::collections::HashMap;
///
/// use quick_kv::prelude::*;
///
/// let typed_hashmap = HashMap::<String, i32>::new().into_typed();
/// ```
pub trait RawIntoTypedValue<T>
{
fn into_typed(self) -> TypedValue<T>;
}
impl<T> RawIntoTypedValue<T> for Vec<T>
{
fn into_typed(self) -> TypedValue<T>
{
TypedValue::Vec(self)
}
}
impl<T> RawIntoTypedValue<T> for HashMap<String, T>
{
fn into_typed(self) -> TypedValue<T>
{
TypedValue::Hash(self)
}
}
impl<T> RawIntoTypedValue<T> for Option<T>
{
fn into_typed(self) -> TypedValue<T>
{
TypedValue::Option(self)
}
}