Add benchmarks and CI tests

Author: vlopes11

.github/workflows/ci.yml

@@ -0,0 +1,45 @@
+name: Test nightly
+
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - v*
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    - name: Install toolchain
+      uses: actions-rs/toolchain@v1
+      with:
+        profile: minimal
+        toolchain: nightly
+        override: true
+
+    - name: Install rustfmt
+      run: rustup component add rustfmt
+
+    - name: Check formatting
+      uses: actions-rs/cargo@v1
+      with:
+        command: fmt
+        args: --all --verbose -- --check
+
+    - name: Run tests
+      uses: actions-rs/cargo@v1
+      with:
+        command: test
+        args: --verbose
+
+    - name: Docs
+      uses: actions-rs/cargo@v1
+      with:
+        command: doc
+        args: --no-deps

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "msgpacker"
-version = "0.1.1"
+version = "0.1.3"
 authors = ["Victor Lopez <victor@codx.io>"]
 categories = ["compression", "encoding", "parser-implementations"]
 edition = "2021"
@@ -11,3 +11,15 @@ repository = "https://github.com/codx-dev/msgpacker"
 description = "MessagePack protocol implementation for Rust."
 
 [dependencies]
+
+[dev-dependencies]
+criterion = "0.3"
+
+[profile.bench]
+lto = true
+incremental = false
+codegen-units = 1
+
+[[bench]]
+name = "pack"
+harness = false

README.md

@@ -75,7 +75,7 @@ message.pack(&mut cursor).expect("Message pack failed");
 
 cursor.rewind().expect("Reset the cursor to the beginning");
 
-// The consumer need to guarantee himself the cursor source will live long enough to satify the
+// The consumer need to guarantee himself the cursor source will live long enough to satisfy the
 // lifetime of the message reference.
 //
 // If this is guaranteed, then the function is safe.
@@ -109,3 +109,20 @@ let value = restored["some-key"]
 
 assert_eq!(value, -15);
 ```
+
+## Benchmarks
+
+Results obtained with `Intel(R) Core(TM) i9-9900X CPU @ 3.50GHz`
+
+```ignore,no_run
+$ cargo bench
+msgpack nil             time:   [3.3648 ns 3.3783 ns 3.3928 ns]
+msgunpack nil           time:   [25.925 ns 26.008 ns 26.097 ns]
+msgunpack ref nil       time:   [22.632 ns 22.709 ns 22.789 ns]
+msgpack int             time:   [5.9986 ns 6.0216 ns 6.0525 ns]
+msgunpack int           time:   [25.481 ns 25.579 ns 25.680 ns]
+msgunpack ref int       time:   [22.635 ns 22.727 ns 22.830 ns]
+msgpack map             time:   [1.1588 us 1.1626 us 1.1667 us]
+msgunpack map           time:   [25.955 ns 26.045 ns 26.141 ns]
+msgunpack ref map       time:   [22.626 ns 22.716 ns 22.810 ns]
+```

benches/pack.rs

@@ -0,0 +1,55 @@
+use criterion::{black_box, criterion_group, criterion_main, Criterion};
+
+use msgpacker::prelude::*;
+
+pub fn pack(c: &mut Criterion) {
+    let message_nil = Message::Nil;
+    let message_int = Message::from(i64::MIN);
+
+    let m = (0..100)
+        .map(|i| MapEntry::new("some-key".into(), i.into()))
+        .collect::<Vec<MapEntry>>();
+
+    let message_map = Message::map(m);
+
+    let mut buffer = vec![0u8; 4096];
+
+    c.bench_function("msgpack nil", |b| {
+        b.iter(|| message_nil.pack(black_box(&mut buffer)).unwrap())
+    });
+
+    c.bench_function("msgunpack nil", |b| {
+        b.iter(|| Message::unpack(black_box(&mut buffer.as_slice())).unwrap())
+    });
+
+    c.bench_function("msgunpack ref nil", |b| {
+        b.iter(|| unsafe { MessageRef::unpack(black_box(&mut buffer.as_slice())).unwrap() })
+    });
+
+    c.bench_function("msgpack int", |b| {
+        b.iter(|| message_int.pack(black_box(&mut buffer)).unwrap())
+    });
+
+    c.bench_function("msgunpack int", |b| {
+        b.iter(|| Message::unpack(black_box(&mut buffer.as_slice())).unwrap())
+    });
+
+    c.bench_function("msgunpack ref int", |b| {
+        b.iter(|| unsafe { MessageRef::unpack(black_box(&mut buffer.as_slice())).unwrap() })
+    });
+
+    c.bench_function("msgpack map", |b| {
+        b.iter(|| message_map.pack(black_box(&mut buffer)).unwrap())
+    });
+
+    c.bench_function("msgunpack map", |b| {
+        b.iter(|| Message::unpack(black_box(&mut buffer.as_slice())).unwrap())
+    });
+
+    c.bench_function("msgunpack ref map", |b| {
+        b.iter(|| unsafe { MessageRef::unpack(black_box(&mut buffer.as_slice())).unwrap() })
+    });
+}
+
+criterion_group!(benches, pack);
+criterion_main!(benches);