compact-rc 0.5.2

Low-memory reference-counting pointers
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36

# compact-rc
Low-memory reference-counting pointers.

The types in this crate have almost the same methods as standard `Rc` and `Arc`.
The differences from the standard type are as follows:

- Weak reference is not supported.
- Small integers can be used as refcount.

| Crate        | Strong count                       | Weak count    |
| ------------ | ---------------------------------- | ------------- |
| `std`        | `usize`                            | `usize`       |
| `compact-rc` | `u8`, `u16`, `u32`, `u64`, `usize` | not supported |

## Example
```rust
use compact_rc::Rc8;

fn main() {
    // rc1 is a pointer containing i8 value with u8 refcount.
    let rc1: Rc8<i8> = Rc8::new(100);

    assert_eq!(Rc8::strong_count(&rc1), 1);
    assert_eq!(*rc1, 100);

    // Increment the refcount.
    // The value is shared by rc1 and rc2.
    let rc2 = rc1.clone();

    assert_eq!(Rc8::strong_count(&rc1), 2);
    assert_eq!(Rc8::strong_count(&rc2), 2);
    assert_eq!(*rc1, 100);
    assert_eq!(*rc2, 100);
    assert!(Rc8::ptr_eq(&rc1, &rc2));
}
```