spinlock 0.1.0

docs.rs failed to build spinlock-0.1.0
Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.
Visit the last successful build: spinlock-0.1.2

spinlock-rs

Build Status

Documentation

This Rust library implements a simple spinlock.

Build

Just run cargo build.

Usage

When calling lock on a Spinlock you will get a reference to the data. When this reference is dropped, the lock will be unlocked.

extern crate spinlock;
use spinlock::Spinlock;

fn main()
{
    let spinlock = Spinlock::new(0u);

    // Modify the data
    {
      let mut data = spinlock.lock();
      *data = 2;
    }

    // Read the data
    let answer =
    {
      let data = spinlock.lock();
      *data
    };

    println!("Answer is {}", answer);
}

To share the lock, an Arc<Spinlock<T>> may be used.

Remarks

The behaviour of this lock is similar to that of std::sync::Mutex. It differs on the following:

  • The lock will not be poisoned in case of failure;
  • The lock can also be used from a plain thread (such as a bare pthread).