#serialization #deserialize #messagepack #data-file #rmp

rmp_fs

A small lib that help to serialize and deserialize from/to rmp (RustMessagePack) with a file

7 releases (stable)

1.0.4 Jan 2, 2023
1.0.3 Feb 3, 2022
1.0.2 Jan 1, 2022
0.2.3 Apr 4, 2021
0.1.0 Feb 16, 2020

#241 in Filesystem

MIT license

12KB
158 lines

Licence Version dependency status Download

README

rmp_fs

A small lib that help to serialize and deserialize from/to rmp (RustMessagePack) with a file. It does nothing special, just encapsulates rmp_serde into functions that can be used repeatedly.

Example:

#[macro_use]
extern crate serde_derive;

use rmp_fs::{save_to_rmp, load_from_rmp};
use std::path::Path;

// Define a struct of data
#[derive(Debug, PartialEq, Deserialize, Serialize)]
struct ExampleData {
    value: i64,
    message: String,
}

fn main() {
    let file_name = Path::new("test_rmp_fs.blob");

    let data = ExampleData {
        value: -123456,
        message: "Example rmp_fs".to_string()
    };

    // Save to a file it return Result<(), Box<dyn Error>>
    save_to_rmp(file_name, &data).expect("Fail to save as rmp.");

    // Load from a file it return Result<T, Box<dyn Error>>
    let data2: ExampleData =load_from_rmp(file_name).expect("Fail to load from rmp.");
    println!("{:?}\n{:?}",data,data2);
}

Note:

According my test the struct below has a size of 248 bytes using rmp and 389 bytes using cbor

#[derive(Debug, PartialEq, Deserialize, Serialize)]
    struct StructTest01 {
        text : String,
        value1 : u16,
        value2 : i32,
        value3 : u8,
        value4 : i16,
        value5 : u32,
        value6 : u64,
        value7 : i64,
        value8 : usize,
        value9 : f32,
        value10 : f64,
        array : Vec<u8>,
        tuple : (DateTime<Utc>,u64),
        complex : StructTest02,
    }

    #[derive(Debug, PartialEq, Deserialize, Serialize)]
    struct StructTest02 {
        data_v : Vec<i16>,
        data_m : HashMap<String,String>,
        state : bool,
    }

Dependencies

~0.8–1.5MB
~32K SLoC