13 releases

0.2.0 Nov 6, 2021
0.1.3 Mar 6, 2021
0.1.2 Jul 4, 2020
0.1.1 Aug 29, 2019
0.0.1 Nov 26, 2016

#717 in Data structures

Download history 68/week @ 2024-07-22 34/week @ 2024-07-29 28/week @ 2024-08-05 34/week @ 2024-08-12 25/week @ 2024-08-19 49/week @ 2024-08-26 23/week @ 2024-09-02 25/week @ 2024-09-09 23/week @ 2024-09-16 46/week @ 2024-09-23 24/week @ 2024-09-30 8/week @ 2024-10-07 34/week @ 2024-10-14 16/week @ 2024-10-21 23/week @ 2024-10-28 44/week @ 2024-11-04

118 downloads per month
Used in 3 crates

MIT license

105KB
2.5K SLoC

Commit Log

Sequential, disk-backed commit log library for Rust. The library can be used in various higher-level distributed abstractions on top of a distributed log such as Paxos, Chain Replication or Raft.

Crates.io Docs.rs Travis

Documentation

Usage

First, add this to your Cargo.toml:

[dependencies]
commitlog = "0.1"
extern crate commitlog;

use commitlog::*;

fn main() {
    // open a directory called 'log' for segment and index storage
    let opts = LogOptions::new("log");
    let mut log = CommitLog::new(opts).unwrap();

    // append to the log
    log.append("hello world").unwrap(); // offset 0
    log.append("second message").unwrap(); // offset 1

    // read the messages
    let messages = log.read(0, ReadLimit::default()).unwrap();
    for msg in messages.iter() {
        println!("{} - {}", msg.offset(), String::from_utf8_lossy(msg.payload()));
    }

    // prints:
    //    0 - hello world
    //    1 - second message
}

Prior Art

Dependencies

~420–760KB
~10K SLoC