#automation

rt_ref

Internal Ref types for rt_ref and rt_vec

5 releases

0.2.0 Jul 15, 2022
0.1.3 Jul 14, 2022
0.1.2 Jun 30, 2022
0.1.1 Jun 27, 2022
0.1.0 Jun 27, 2022

#826 in Data structures

Download history 98/week @ 2022-12-06 193/week @ 2022-12-13 303/week @ 2022-12-20 219/week @ 2022-12-27 98/week @ 2023-01-03 193/week @ 2023-01-10 255/week @ 2023-01-17 92/week @ 2023-01-24 203/week @ 2023-01-31 138/week @ 2023-02-07 178/week @ 2023-02-14 362/week @ 2023-02-21 288/week @ 2023-02-28 149/week @ 2023-03-07 217/week @ 2023-03-14 161/week @ 2023-03-21

973 downloads per month
Used in 22 crates (2 directly)

MIT/Apache

38KB
874 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.0" # or
rt_ref = { version = "0.2.0", 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

  • unsafe_debug