Well documented, safe-leaning, sound, low-level API bindings to HWND-adjacent APIs.
Intended use cases include:
- Building block for higher level APIs.
- Interop with existing win32-consuming C or C++ codebases (incrementally RIIRing?)
- Direct use for cases where extra abstraction / higher level APIs are overkill.
Goals to service these use cases, in order of priority, are:
- APIs should be as sound as possible.
- Spam unit tests and/or doc-tests to try to break safe APIs.
- Thorough safety documentation of any fns or traits that must remain
unsafe.
- Keep a 1:1 mapping to raw windows types and APIs as much as possible.
- Maximum interoperability with existing C or C++ codebases.
- Avoids infinite yak shaving.
- Additional error checking / debug spam is generally discouraged to avoid suprising RIIRers with new edge cases, except to avoid soundness issues.
- Make APIs as safe as possible.
- Some
unsafewill generally still be required to implement said APIs. - Eliminating
unsafefor perfectly sound APIs will make auditing the remainingunsafecode easier.
- Some
- Provide excellent documentation.
- Rust specific examples for everything.
- Thoroughly document edge cases, error codes, etc.
- Aiming to be even better than MSDN.
Licensed under either of
- Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.