https://github.com/asomers/futures-locks

Futures-aware lock primitives
https://github.com/asomers/futures-locks

Last synced: 1 day ago
JSON representation

Futures-aware lock primitives

• Host: GitHub
• URL: https://github.com/asomers/futures-locks
• Owner: asomers
• License: apache-2.0
• Created: 2018-04-04T04:57:15.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-10-13T20:08:06.000Z (2 months ago)
• Last Synced: 2024-10-14T02:46:17.295Z (2 months ago)
• Language: Rust
• Size: 842 KB
• Stars: 39
• Watchers: 6
• Forks: 12
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE-APACHE

Awesome Lists containing this project

README

        
# futures-locks

A library of [Futures]-aware locking primitives.  These locks can safely be used

in asynchronous environments like [Tokio].  When they block, they'll only block

a single task, not the entire reactor.

[![Build Status](https://api.cirrus-ci.com/github/asomers/futures-locks.svg)](https://cirrus-ci.com/github/asomers/futures-locks)

[![CodeCov.io](https://codecov.io/gh/asomers/futures-locks/branch/master/graph/badge.svg)](https://codecov.io/gh/asomers/futures-locks)

[Futures]: https://github.com/rust-lang-nursery/futures-rs

[Tokio]: https:/tokio.rs

```toml

# Cargo.toml

[dependencies]

futures = "0.3.1"

futures-locks = "0.6"

```

# Usage

Generally, the provided primitives work much like their counterparts from the

standard library.  But instead of blocking until ready, they return Futures

which will become ready when the lock is acquired.  See the doc comments for

individual examples.

`futures-locks` requires Rust 1.65.0 or higher.

# License

`futures-locks` is primarily distributed under the terms of both the MIT license

and the Apache License (Version 2.0).

See LICENSE-APACHE, and LICENSE-MIT for details