LibSync

8th May 2024
2 min read

LibSync

LibSync is a library which contains objects which can be used in the synchronisation of application threads.

This this library is structured to compound the features of other “lower level” libraries e.g. it combines crossbeam ArrayQueue objects with Tokio Notify objects to produce a multi-producer-multi-consumer channel that can be waited on asynchronously at both ends.

Todo

Add crossbeam::mpmc::tokio::seg_queue implementation.
Complete std::Notifier
Add documentation
Add tests

Coding Style

This project uses a coding style the emphasises the use of white space over keeping the line and column counts as low as possible.

So this:

fn foo()
{

    bar();

}

Not this:

fn foo()
{
    bar();
}

License

Licensed under either of:

Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0 (see also: https://www.tldrlegal.com/license/apache-license-2-0-apache-2-0))
MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT (see also: https://www.tldrlegal.com/license/mit-license))

at your discretion

Contributing

Please clone the repository and create an issue explaining what feature or features you'd like to add or bug or bugs you'd like to fix and perhaps how you intend to implement these additions or fixes. Try to include details though it doesn't need to be exhaustive and we'll take it from there (dependant on availability).

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.