Adding `commitlog` library as a dependency

Run this command in a terminal, in your project's directory:

cargo add commitlog

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

commitlog = "0.2.0"

The commitlog library will be automatically available globally. Read the commitlog library documentation.

Back to the crate overview.

Readme

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.

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
}

Adding commitlog library as a dependency

Adding `commitlog` library as a dependency