Repository files navigation

PickleDB is a lightweight and simple key-value store written in Rust, heavily inspired byPython's PickleDB

use pickledb::{PickleDb,PickleDbDumpPolicy,SerializationMethod};fnmain(){// create a new DB with AutoDump (meaning every change is written to the file)// and with Json serialization (meaning DB will be dumped to file as a Json object)letmut db =PickleDb::new("example.db",PickleDbDumpPolicy::AutoDump,SerializationMethod::Json);// set the value 100 to the key 'key1'    db.set("key1",&100).unwrap();// print the value of key1println!("The value of key1 is: {}", db.get::<i32>("key1").unwrap());// load the DB from the same filelet db2 =PickleDb::load("example.db",PickleDbDumpPolicy::DumpUponRequest,SerializationMethod::Json).unwrap();// print the value of key1println!("The value of key1 as loaded from file is: {}", db2.get::<i32>("key1").unwrap());}

This crate works with Cargo and can be found incrates.ioAdd this to yourCargo.toml:

[dependencies]pickledb ="0.5.1"

All documentation for this crate can be found indocs.rs

There are currently two examples shipped with PickleDB:

• Hello World which shows the basic usage of PickleDB:create a new DB, load a DB from file, get/set key-value pairs of different types, and more
• Lists which shows how to use lists in PickleDB:create new lists, add/remove items from lists, retrieve items from lists, remove lists, and more

• Bugfix: Add missing JSON feature gate

• Turn on/off file formats with features
• DumpUponRequest policy no longer dumps onDrop
• (internal) Switch CI from TravisCI to GitHub Actions

• Bump up dependencies versions to fix vulnerabilities found in few of them

• Changed all doc tests fromignore tono_run so generated docs don't contain untested warnings
• Changed both instances oflextend to take iterators of references rather than a slice of values
• Fixed bug inload_test()
• Fixed rustfmt and clippy warnings
• Added examples toCargo.toml to allow them to be run via Cargo

• Added new serialization options. Now PickleDB supportsJSON,Bincode,YAML andCBOR serializations
• Added proper error handling (Issue #3)
• UsePath andPathBuf instead of strings to describe DB paths
• Better organization of the code

• Dump the DB to file in a crash-safe manner using a temp file (Thanks jamwt from Redditfor the tip:https://www.reddit.com/r/rust/comments/agumun/check_out_pickledb_a_lightweight_and_simple/ee987j0)
• Extend lists became easier and multiple calls tolcreate(),ladd() andlextend() can be chained
• Added an iterator over keys and values in the DB
• Added an iterator over items in a list