micro_types 0.3.0

Types for distributed systems
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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74

//! # Redis Types
//!
//! This crate provides a set of types that can be stored in Redis. The types are:
//!
//! * [bool](redis::Dbool)
//! * Integer types:
//!     * signed Integer: [i8](redis::Di8), [i16](redis::Di16), [i32](redis::Di32), [i64](redis::Di64), [isize](redis::Disize)
//!     * unsigned Integer: [u8](redis::Du8), [u16](redis::Du16), [u32](redis::Du32), [u64](redis::Du64), [usize](redis::Dusize)
//! * [String](redis::DString)
//! * [List](redis::List)
//! * Sync types:
//!     * [Mutex](redis::Mutex)
//!     * [ClockOrdered](redis::ClockOrdered)
//!
//! This crate implements the most common traits for the primitive types, so it is frictionless to use them in place.
//! The methods of the types can be seen in the documentation of [Generic](redis::Generic).
//! With this crate it is possible to create multiple services that shares the values via Redis.
//! This is helpful if you want to create a distributed system and run multiple instances of the same service.
//! Or you want to communicate between different services. All this kind of stuff can be done with this crate.
//!
//! # Upcoming Features
//!
//! It will be possible to create happens-before relationships between store and load operations like atomic types.
//! Also it will be possible to create other backends than Redis.
//!
//! # Usage
//!
//! ```
//! use dtypes::redis::types::Di32 as i32;
//!
//! let client = redis::Client::open("redis://localhost:6379").unwrap();
//! let mut i32 = i32::with_value(1, "test_add", client.clone());
//!
//! i32 = i32 + i32::with_value(2, "test_add2", client.clone());
//! assert_eq!(i32, 3);
//! ```
//!
//! More examples can be found on the doc pages of the types.
//!
//! # Custom Types
//!
//! It is possible to implement your own complex types by implementing the [BackedType](crate::BackedType) trait.
//! But it should not be needed as long as your type implements some or all of the various [Ops](https://doc.rust-lang.org/std/ops/index.html) traits.
mod barrier;
mod bool_type;
mod clock;
mod generic;
mod helper;
mod integer;
mod list;
mod mutex;
mod rwlock;
mod string;

pub(crate) use helper::apply_operator;

pub mod sync {
    pub use crate::redis::barrier::{Barrier, BarrierWaitResult};
    pub use crate::redis::clock::ClockOrdered;
    pub use crate::redis::mutex::{Guard, LockError, Mutex};
    pub use crate::redis::rwlock::{RwLock, RwLockReadGuard, RwLockWriteGuard};
}

/// Holds all the types that can be stored in Redis.
pub mod types {
    pub use crate::redis::bool_type::TBool as Dbool;
    pub use crate::redis::generic::Generic;
    pub use crate::redis::integer::{
        Ti16 as Di16, Ti32 as Di32, Ti64 as Di64, Ti8 as Di8, Tisize as Disize, Tu16 as Du16,
        Tu32 as Du32, Tu64 as Du64, Tu8 as Du8, Tusize as Dusize,
    };
    pub use crate::redis::list::{List, ListCache, ListIter};
    pub use crate::redis::string::TString as DString;
}