README.md
1winapi-util
2===========
3This crate provides a smattering of safe wrappers around various parts of the
4[winapi](https://crates.io/crates/winapi) crate.
5
6[](https://github.com/BurntSushi/winapi-util/actions)
7[](https://crates.io/crates/winapi-util)
8
9Dual-licensed under MIT or the [UNLICENSE](http://unlicense.org).
10
11
12### Documentation
13
14https://docs.rs/winapi-util
15
16
17### Usage
18
19Add this to your `Cargo.toml`:
20
21```toml
22[dependencies]
23winapi-util = "0.1"
24```
25
26
27### Notes
28
29This crate was born out of frustration with having to write lots of little
30ffi utility bindings in a variety of crates in order to get Windows support.
31Eventually, I started needing to copy & paste a lot of those utility routines.
32Since they are utility routines, they often don't make sense to expose directly
33in the crate in which they are defined. Instead of continuing this process,
34I decided to make a crate instead.
35
36Normally, I'm not a huge fan of "utility" crates like this that don't have a
37well defined scope, but this is primarily a practical endeavor to make it
38easier to isolate Windows specific ffi code.
39
40While I don't have a long term vision for this crate, I will welcome additional
41PRs that add more high level routines/types on an as-needed basis.
42
43**WARNING:** I am not a Windows developer, so extra review to make sure I've
44got things right is most appreciated.
45
46
47### Minimum Rust version policy
48
49This crate's minimum supported `rustc` version is `1.34.0`.
50
51The current policy is that the minimum Rust version required to use this crate
52can be increased in non-breaking version updates. For example, if `crate 1.0`
53requires Rust 1.20.0, then `crate 1.0.z` for all values of `z` will also
54require Rust 1.20.0 or newer. However, `crate 1.y` for `y > 0` may require a
55newer minimum version of Rust.
56
57In general, this crate will be conservative with respect to the minimum
58supported version of Rust.
59
){kind=link}