6 releases

0.2.1 Jan 28, 2024
0.2.0 Jul 15, 2022
0.1.3 Jul 14, 2022
0.1.2 Jun 30, 2022

#235 in Data structures

Download history 234/week @ 2023-12-22 335/week @ 2023-12-29 137/week @ 2024-01-05 95/week @ 2024-01-12 44/week @ 2024-01-19 207/week @ 2024-01-26 147/week @ 2024-02-02 72/week @ 2024-02-09 66/week @ 2024-02-16 77/week @ 2024-02-23 116/week @ 2024-03-01 189/week @ 2024-03-08 109/week @ 2024-03-15 127/week @ 2024-03-22 151/week @ 2024-03-29 64/week @ 2024-04-05

454 downloads per month
Used in 31 crates (2 directly)

MIT/Apache

39KB
876 lines

♐ rt_ref

Crates.io docs.rs CI Coverage Status

Ref types with internal mutability that implement Send and Sync.

These types are shared by rt_map and rt_vec.

Usage

Add the following to Cargo.toml:

rt_ref = "0.2.1" # or
rt_ref = { version = "0.2.1", features = ["unsafe_debug"] }

In code:

use rt_ref::{Cell, Ref, RefMut};

let a = 1;

// Insert a value into a collection, wrapped with `Cell`.
let mut v = Vec::new();
v.push(Cell::new(a));

let v = v; // v is now compile-time immutable.
let a = v.get(0).map(|cell| RefMut::new(cell.borrow_mut()));
a.map(|mut a| {
    *a += 2;
});

let a = v.get(0).map(|cell| Ref::new(cell.borrow()));
assert_eq!(Some(3), a.map(|a| *a));

Features

"unsafe_debug":

The borrowed reference will use the inner type's Debug implementation when formatted.

use rt_ref::{Cell, Ref, RefMut};

let mut v = Vec::new();
v.push(Cell::new("a"));

#[cfg(not(feature = "unsafe_debug"))]
assert_eq!(
    r#"[Cell { flag: 0, inner: UnsafeCell { .. } }]"#,
    format!("{v:?}")
);
#[cfg(feature = "unsafe_debug")]
assert_eq!(r#"[Cell { flag: 0, inner: "a" }]"#, format!("{v:?}"));

License

Licensed under either of

at your option.

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.

No runtime deps

Features