Crate voluntary_servitude

Atomic abstractions and thread-safe appendable list with lock-free iterators

Features

• Atomic abstractions (Atomic, AtomicOption, FillOnceAtomicOption, FillOnceAtomicArc)
• Thread-safe appendable list with a lock-free iterator (VoluntaryServitude - also called VS)
• Serde serialization/deserialization ("serde-traits" feature)
• par_extend, from_par_iter rayon implementation ("rayon-traits" feature)
• Call this code from C (FFI) (also in ./examples)
• System Allocator ("system-alloc" feature)
• Logging ("logs" feature)

Atomic abstractions

• Atomic -> atomic Box<T>
• AtomicOption -> atomic Option<Box<T>>
• FillOnceAtomicOption -> atomic Option<Box<T>> that can give references (ideal for iterators)
• FillOnceAtomicArc -> atomic Option<Arc<T>> with a limited Api (like FillOnceAtomicOption)

With Atomic and AtomicOption it’s not safe to get a reference, you must replace the value to access it

To safely get a reference to T you must use FillOnceAtomicOption and accept the API limitations

A safe AtomicArc is impossible without a GC, so you must use ArcCell from crossbeam (locks to clone) or FillOnceAtomicArc

Thread-safe appendable list that can create a lock-free iterator

• VoluntaryServitude (also called VS)

Api of VS Iterator

• Iter

Modules

ffi

Voluntary Servitude Foreign Function Interface (FFI)

Macros

voluntary_servitude

Creates new VS with specified elements as in the vec! macro

vs

Alias for voluntary_servitude macro

Structs

Atomic

Atomic abstractions of a Box<T>

AtomicOption

Atomic abstraction of a Option<Box<T>>

FillOnceAtomicArc

Atomic abstractions of a Option<Arc<T>> that can provide access to a cloned Option<Arc<T>> and a Option<&T>

FillOnceAtomicOption

Atomic abstraction of a Option<Box<T>> that can provide access to a Option<&T>

Iter

Lock-free iterator based on VS

NotEmpty

Happens when you call try_store in a already filled AtomicOption/FillOnceAtomicOption

VoluntaryServitude

Appendable list with lock-free iterator (also called VS)

Statics

GLOBAL_ALLOCsystem-alloc

Represents the use of the system’s allocator instead of rust’s default

Functions

setup_loggerlogs

Setup logger according to RUST_LOG env var

Type Definitions

VS

VoluntaryServitude’s alias