#state #model #lmdb #data-model #key-value-store #data-store #data

mdl

数据模型库,用于在线程和进程之间共享应用程序状态,并将数据持久保存在文件系统中。实现了将结构体实例存储在LMDB数据库和其他方法(如BTreeMap)中的简单方式。

10个版本 (6个稳定版)

1.0.5 2020年8月13日
1.0.4 2018年9月27日
1.0.3 2018年8月3日
1.0.2 2018年7月29日
0.1.3 2018年7月29日

#939数据库接口

Download history 7/week @ 2024-03-10 7/week @ 2024-03-17 1/week @ 2024-03-24 10/week @ 2024-03-31 21/week @ 2024-04-07 4/week @ 2024-04-14 6/week @ 2024-04-21

每月98次下载

GPL-3.0许可证

32KB
513

带缓存的应用程序状态库

此crate提供存储数据并自动持久化到文件系统的功能。主要目标是有一个单一的对象来查询应用程序状态,并能够修改此状态。

它还提供了一个简单的信号器,以便能够订阅更新/删除信号,并在缓存模型修改上执行自定义操作。

为了存储信息,我们使用键值存储,因此每个模型都应该提供一个唯一的键来标识它。使用NoSQL模式技术,通过键添加模型之间的关系,以便轻松查询。

基本的Cache对象使用LMDB作为存储,因此您可以从不同的线程或进程访问相同的缓存。

基本用法

使用最简单的方法是实现您结构体的Model特质,这样您就可以获取存储删除

use mdl::Cache;
use mdl::Model;
use mdl::Continue;

use serde::{Deserialize, Serialize};

#[derive(Serialize, Deserialize, Debug)]
struct A {
    pub p1: String,
    pub p2: u32,
}
impl Model for A {
    fn key(&self) -> String {
        format!("{}:{}", self.p1, self.p2)
    }
}

fn main() {
    // initializing the cache. This str will be the fs persistence path
    let db = "/tmp/mydb.lmdb";
    let cache = Cache::new(db).unwrap();

    // create a new *object* and storing in the cache
    let a = A{ p1: "hello".to_string(), p2: 42 };
    let r = a.store(&cache);
    assert!(r.is_ok());

    // querying the cache by key and getting a new *instance*
    let a1: A = A::get(&cache, "hello:42").unwrap();
    assert_eq!(a1.p1, a.p1);
    assert_eq!(a1.p2, a.p2);
}

信号

为了允许轻松通知缓存中的更改,此crate提供了一个信号系统,而Model特质提供了store_sigdelete_sig,这些用于存储或删除并发出相应的信号。

实现了两个信号器,一个可以在线程之间Send,另一个应该始终在同一个线程中,这允许我们为信号注册回调,并且这些回调应该实现Send以供SignalerAsync使用。

示例

use mdl::SigType;
use mdl::SignalerAsync;
use mdl::Cache;
use mdl::Model;

use serde::{Deserialize, Serialize};

use std::sync::{Arc, Mutex};
use std::{thread, time};

#[derive(Serialize, Deserialize, Debug)]
struct B {
    pub id: u32,
    pub complex: Vec<String>,
}
impl Model for B {
    fn key(&self) -> String {
        format!("b:{}", self.id)
    }
}

fn main() {
    let db = "/tmp/test.lmdb";
    let cache = Cache::new(db).unwrap();
    // using the async signaler that run in other thread
    let sig = SignalerAsync::new();
    // starting the signaler loop, this can be stoped
    // calling sig.stop() or when the signaler drops
    sig.signal_loop();

    let up_c = Arc::new(Mutex::new(0));
    let rm_c = Arc::new(Mutex::new(0));
    let counter = Arc::new(Mutex::new(0));

    let c1 = up_c.clone();
    let c2 = rm_c.clone();
    let c3 = counter.clone();

    // Subscribing to the "b" signal, that's emited always
    // that an object which key starting with "b" is modified.
    // We're using the SignalerAsync so this callback will
    // be called in a different thread, for that reason we're
    // pasing Arc<Mutex<T>> to be able to modify the counters
    let _id = sig.subscribe("b", Box::new(move |sig| {
        match sig.type_ {
            SigType::Update => *c1.lock().unwrap() += 1,
            SigType::Delete => *c2.lock().unwrap() += 1,
        };

        *c3.lock().unwrap() += 1;
    }));

    let b = B{ id: 1, complex: vec![] };
    // we use the store_sig instead the store to emit the
    // corresponding signal, if we use the store, the callback
    // wont be called.
    let r = b.store_sig(&cache, &sig);
    assert!(r.is_ok());

    let b = B{ id: 2, complex: vec![] };
    let r = b.store_sig(&cache, &sig);
    assert!(r.is_ok());

    let r = b.delete_sig(&cache, &sig);
    assert!(r.is_ok());

    // waiting for signal to come
    let ten_millis = time::Duration::from_millis(10);
    thread::sleep(ten_millis);

    assert_eq!(*up_c.lock().unwrap(), 2);
    assert_eq!(*rm_c.lock().unwrap(), 1);
    assert_eq!(*counter.lock().unwrap(), 3);
}

您可以使用Signaler而无需Model,可以发出自定义信号并订阅该信号,例如

use mdl::SigType;
use mdl::Signaler;
use mdl::SignalerAsync;
use std::{thread, time};

use serde::{Deserialize, Serialize};

fn main() {
    let sig = SignalerAsync::new();
    sig.signal_loop();

    let _id = sig.subscribe("my signal", Box::new(move |sig| {
        println!("my signal is called");
    }));

    let _ = sig.emit(SigType::Update, "my signal");

    // waiting for signal to come
    let ten_millis = time::Duration::from_millis(10);
    thread::sleep(ten_millis);
}

依赖项

~1.3–2.2MB
~50K SLoC