fremkit 0.1.1

A simple broadcast log
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

# Fremkit

![Crates.io](https://img.shields.io/crates/v/fremkit) ![docs.rs](https://img.shields.io/docsrs/fremkit)

Fremkit is a simple broadcast log.

A Log's primary use case is to store an immutable sequence of messages, events, or other data, and to allow multiple readers to access the data concurrently.

## Features

- Bounded log structure with fixed size.
- Fast and efficient, with performances comparable to a `Mutex<Vec<_>>`. (See benchmarks)
- Lock-free, and thread-safe design.

## Usage

Add this to your `Cargo.toml`:

```toml
[dependencies]
fremkit = "^0.1"
```

## Example

```rust
use fremkit::bounded::Log;

let log: Log<u64> = Log::new(100);
log.push(1).unwrap();
log.push(2).unwrap();

assert_eq!(log.get(0), Some(&1));
assert_eq!(log.get(1), Some(&2));
```

## License

This crate is under the Apache-2.0 License.