1 unstable release
0.1.0 | Jul 3, 2024 |
---|
#689 in Data structures
11KB
201 lines
Collect-Me
Description
This project is a library of data structures that may or may not be useful but are nonetheless not included in the Rust standard library.
Contributing
Please file a pull request with any changes/improvements you would like to add to the project. Please make sure you have done the following before submitting your PR:
- Check that all the tests pass with
cargo test
. - Make sure that all relevant documentation has been updated. (Any function/module/item making up part of the public API MUST be documented.)
- Do not file duplicate pull requests. Check that there doesn't already exist a PR for the feature you are trying to implement/bug you are trying to fix.
- For any additional data-structures or features added, write thorough tests to ensure all critical invariants hold.
- Every single use of the
unsafe
keyword must be accompanied by a comment documenting exactly why the code does not violate Rust's safety guarentees. Those comments should be styled as such:
fn some_function() {
let some_val = 42;
let some_ptr: *const i32 = std::mem::addr_of!(some_val);
// SAFETY: Since val hasn't been moved or dropped `some_ptr` will
// still be valid and is therefore safe to dereference.
let val_copy = unsafe { *some_ptr };
}