std-semaphore 0.1.0

A counting, blocking sempahore extracted from rust 1.7.0.
Documentation
  • Coverage
  • 85.71%
    6 out of 7 items documented1 out of 6 items with examples
  • Size
  • Source code size: 8.74 kB This is the summed size of all the files inside the crates.io package for this release.
  • Documentation size: 1.44 MB This is the summed size of all files generated by rustdoc for all configured targets
  • Links
  • Homepage
  • Documentation
  • invenia/std-semaphore
    8 4 2
  • crates.io
  • Dependencies
    • —
  • Versions
  • Owners
  • iamed2

std-semaphore

Build Status

Documentation (master)

A counting, blocking semaphore extracted from rust 1.7.0.

Semaphores are a form of atomic counter where access is only granted if the counter is a positive value. Each acquisition will block the calling thread until the counter is positive, and each release will increment the counter and unblock any threads if necessary.

Usage

Add this to your Cargo.toml:

[dependencies]
std-semaphore = "0.1"

and this to your crate root:

extern crate std_semaphore;

Examples

use std_semaphore::Semaphore;

// Create a semaphore that represents 5 resources
let sem = Semaphore::new(5);

// Acquire one of the resources
sem.acquire();

// Acquire one of the resources for a limited period of time
{
    let _guard = sem.access();
    // ...
} // resources is released here

// Release our initially acquired resource
sem.release();

License

Unless otherwise noted, all code, tests, and docs are © 2014 The Rust Project Developers and dual-licensed under the Apache 2.0 and MIT licenses. See the copyright declaration at the top of src/lib.rs for more.