Build Status Latest Release Documentation

libuv-rs

A safe rust wrapper for [libuv].

Getting Started

Include [libuv-rs] as a dependency in your Cargo.toml:

toml [dependencies] libuv = "~1.0.0"

[libuv-rs] uses semantic versioning.

As of v2.0.1, libuv-rs supports the skip-pkg-config feature. This is passed to [libuv-sys2] to skip searching for a local install of [libuv] via pkg-config and, instead, causes [libuv-sys2] to build [libuv] from source.

You'll want to make sure to familiarize yourself with [libuv] by reading [libuv's documentation]. You can then familiarize yourself with [libuv-rs] by reading the [examples] and [documentation].

Unimplemented

[libuv-rs] strives to implement wrappers for all [libuv] functionality. However, some functionality was purposefully excluded as rust provides implementations of its own. That is: threads and synchronization (mutexes, locks, semaphores, conditional variables, barriers, etc).

If your rust project would benefit from [libuv]'s threading or synchronization primitives, please file an Issue on github and I'll implement wrappers for it!

Cross-Platform Considerations

[libuv-rs] depends on [libuv-sys2], which depends on [bindgen]. On Windows, [bindgen] requires rust's msvc toolchain.