Crate libsync

Source
Expand description

LibSync combines “lower level” library objects to produce channels and other synchronisation objects e.g. it combines Crossbeam ArrayQueue objects with Tokio Semaphore objects to produce a multi-producer-multi-consumer channel that can be waited on asynchronously on both sides.

It also has objects that help you keep count of messages in a pipeline and “return stores” for “returning” values from one thread to another using a reusable location.

In addition to message counters, you may find IO channels useful when working with actors.


§Todo

  • Add more documentation
  • Add tests
  • Decide on what is staying in the library.
  • Get the channels to work with other async runtimes, preferably via generics.

§Maybe

  • Add synchronous channel implementations.

§Coding Style

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

So this:

fn bar() {}

fn foo()
{

    bar();

}

Not this:

fn bar() {}

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.

Modules§

crossbeamcrossbeam
Crossbeam and Tokio based objects.
stdstd
Synchronisation - originally from corlib::sync.
tokio_helperstokio
Helper objects for Tokio objects.

Structs§

BoundedSharedDetails
Details that are shared between bounded sender and receiver parts of a channel.
SharedDetails
Details that are shared between sender and receiver parts of a channel.

Enums§

BoundedSendError
Provides the reason for the error if a message cannot be sent on a bounded channel.
BoundedSendErrorType
ReceiveError
Provides the reasons for why a value cannot be received from a channel.
TimeoutBoundedSendError
Was there a BoundedSendError or a time-out?
TimeoutReceiveError
Was there a ReceiveError or a time-out?
TimeoutSendError
Did the operation time-out or was there another issue?

Type Aliases§

BoundedSendResult
The result of a send attempt on a bounded channel.
ReceiveResult
The result of a receive attempt on a channel.
SendResult
The result of a send attempt on a channel.