rc-box

Crates.iorc-box
lib.rsrc-box
version1.2.0
sourcesrc
created_at2020-01-31 22:26:05.65372
updated_at2022-03-16 21:41:10.273477
descriptionKnown unique versions of Rc and Arc.
homepage
repositoryhttps://github.com/CAD97/pointer-utils/tree/master/crates/rc-box
max_upload_size
id203774
size27,896
Christopher Durham (CAD97)

documentation

README

Known unique versions of Rc and Arc. This allows them to be used for mutable ownership.

The main reason to use RcBox or ArcBox is for types that will be reference counted, but need some "fixing up" done after being allocated behind the reference counted pointer. With the standard library types, you would use get_mut and have to handle the impossible case where the value was shared. With the known unique versions, you have DerefMut, so it's as simple as mutating behind a Box.

Related Crates

  • erasable: Erase pointers of their concrete type.
  • ptr-union: Pointer unions the size of a pointer.
  • rc-borrow: Borrowed forms of Rc and Arc.
  • slice-dst: Support for custom slice-based DSTs.

Why not triomphe?

Triomphe is a great atomic reference counting library! The main difference between triomphe and these utilities is that triomphe implements a new Arc type that doesn't support weak references (and as such does not have to pay the cost of handling potential weak references), whereas these pointer utilities use the standard library's reference counting types. If you need to work with standard library Arc/Rc, triomphe won't work for you.

If you want a more battle-tested library by the servo developers, use triomphe. If you want small, self-contained extensions to the standard library types, use these pointer utilities.

Additionally, triomphe only supports atomic reference counting. We provide support for both Arc and Rc.

Minimum Supported Rust Version

We require a minimum Rust version of 1.41.0. This is for an adjustment of local trait impl checking.

Minimum version support is only guaranteed with minimal version resolution (-Z minimal-versions/--minimal-versions) due to how dependencies are handled. The minimum version of Rust will only be incremented with minor version bumps, not patch version bumps, and will be deliberate and clearly noted in change notes.

License

Licensed under either of

at your option.

If you are a highly paid worker at any company that prioritises profit over people, you can still use this crate. I simply wish you will unionise and push back against the obsession for growth, control, and power that is rampant in your workplace. Please take a stand against the horrible working conditions they inflict on your lesser paid colleagues, and more generally their disrespect for the very human rights they claim to fight for.

Contribution

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.

Commit count: 180

cargo fmt