#fifo-queue #queue #fifo #io #file-io

queue-file

queue-file is a lightning-fast, transactional, file-based FIFO

16 stable releases

1.4.10 Mar 17, 2023
1.4.8 Feb 14, 2023
1.4.6 Jul 4, 2022
1.3.0 Feb 22, 2022
1.0.2 Jun 27, 2019

#146 in Data structures

Download history 1463/week @ 2024-10-10 853/week @ 2024-10-17 991/week @ 2024-10-24 1508/week @ 2024-10-31 1722/week @ 2024-11-07 1406/week @ 2024-11-14 1210/week @ 2024-11-21 342/week @ 2024-11-28 464/week @ 2024-12-05 688/week @ 2024-12-12 1063/week @ 2024-12-19 190/week @ 2024-12-26 105/week @ 2025-01-02 146/week @ 2025-01-09 227/week @ 2025-01-16 313/week @ 2025-01-23

791 downloads per month
Used in 2 crates

Apache-2.0

49KB
930 lines

queue-file

Crate API License Windows Build Status

queue-file is a lightning-fast, transactional, file-based FIFO.

Addition and removal of an element from the queue is an O(1) operation and is atomic. Writes are synchronous by default; data will be written to disk before an operation returns.

queue-file crate is a feature complete and binary compatible port of QueueFile class from Tape2 by Square, Inc. Check the original project here.

Documentation

Usage

To use queue-file, first add this to your Cargo.toml:

[dependencies]
queue-file = "1"

Example

use queue_file::QueueFile;

fn main() {
    let mut qf = QueueFile::open("example.qf")
        .expect("cannot open queue file");

    qf.add("ELEMENT #1".as_bytes()).expect("add failed");
    qf.add("ELEMENT #2".as_bytes()).expect("add failed");
    qf.add("ELEMENT #3".as_bytes()).expect("add failed");

    qf.remove().expect("remove failed");

    for (index, elem) in qf.iter().enumerate() {
        println!(
            "{}: {} bytes -> {}",
            index,
            elem.len(),
            std::str::from_utf8(&elem).unwrap_or("<invalid>")
        );
    }

    qf.clear().expect("clear failed");
}

MSRV

Current MSRV is 1.58.1

License

This project is licensed under the Apache 2.0 license.

Dependencies

~2MB
~42K SLoC