#top #spinlock #spin-lock

spinning_top

A simple spinlock crate based on the abstractions provided by lock_api

9 releases

0.3.0 Oct 19, 2023
0.2.5 Feb 24, 2023
0.2.4 May 13, 2021
0.2.3 Apr 1, 2021
0.1.0 Feb 12, 2020

#36 in Concurrency

Download history 13766/week @ 2023-08-14 12923/week @ 2023-08-21 12447/week @ 2023-08-28 12586/week @ 2023-09-04 13954/week @ 2023-09-11 12294/week @ 2023-09-18 11602/week @ 2023-09-25 12133/week @ 2023-10-02 12484/week @ 2023-10-09 13356/week @ 2023-10-16 16369/week @ 2023-10-23 14693/week @ 2023-10-30 15763/week @ 2023-11-06 16274/week @ 2023-11-13 14829/week @ 2023-11-20 15350/week @ 2023-11-27

63,611 downloads per month
Used in 76 crates (7 directly)

MIT/Apache

53KB
552 lines

spinning_top

image of a spinning top

Build Status Docs.rs Badge

A simple spinlock crate based on the abstractions provided by lock_api.

Example

First, import the crate as a dependency in your Cargo.toml. Then you can use it in the following way:

use spinning_top::Spinlock;

fn main() {
    // Wrap some data in a spinlock
    let data = String::from("Hello");
    let spinlock = Spinlock::new(data);
    make_uppercase(&spinlock); // only pass a shared reference
    // We have ownership of the spinlock, so we can extract the data without locking
    // Note: this consumes the spinlock
    let data = spinlock.into_inner();
    assert_eq!(data.as_str(), "HELLO");
}

fn make_uppercase(spinlock: &Spinlock<String>) {
    // Lock the spinlock to get a mutable reference to the data
    let mut locked_data = spinlock.lock();
    assert_eq!(locked_data.as_str(), "Hello");
    locked_data.make_ascii_uppercase();

    // the lock is automatically freed at the end of the scope
}

Spinlock::new is a const function. This makes the Spinlock type usable in statics:

use spinning_top::Spinlock;

static DATA: Spinlock<u32> = Spinlock::new(0);

fn main() {
    let mut data = DATA.lock();
    *data += 1;
    assert_eq!(*data, 1);
}

License

Licensed under either of

at your option.

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.

Dependencies

~175KB