shared-vec 0.1.0

Efficient shared container types
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
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58

# `shared-vec`

[![codecov](https://codecov.io/gh/TheVeryDarkness/pest-typed/graph/badge.svg?token=A4L7TXP5DF)](https://codecov.io/gh/TheVeryDarkness/pest-typed)

`shared-vec` is a Rust crate that provides immutable reference-counted vector and string types allowing sharing data (or even a part of it) without lifetime-bound references.

## Features

- Immutable reference-counted vector type `Vec<C, T>`, where `C` is a counter type implementing the `Counter` trait.
- Immutable reference-counted string type `String<C>`, where `C` is a counter type implementing the `Counter` trait.
- Common type aliases `RcVec<T>`, `ArcVec<T>`, `RcString`, and `ArcString` for ease of use.
- Safe and efficient memory management with customizable reference counting strategies.

## Usage

Add `shared-vec` to your `Cargo.toml`:

```toml
[dependencies]
shared-vec = "0.1"
```

Then, you can use the provided types in your Rust code:

```rust
use shared_vec::{RcVec, ArcString};

// Create
let vec: RcVec<i32> = RcVec::from_boxed_slice(Box::new([1, 2, 3]));
let string: ArcString = ArcString::from_boxed_str("Hello, world!".to_owned().into_boxed_str());

// Clone
let vec_clone = vec.clone();
let string_clone = string.clone();

// Access data
println!("{:?}", &vec[..]);
println!("{}", &string[..]);

// Borrow slices
let slice = vec.idx(1..3);
println!("{:?}", slice);
assert_eq!(slice.as_slice(), &[2, 3]);
let str_slice = string.idx(7..12);
println!("{:?}", str_slice);
assert_eq!(str_slice.as_str(), "world");
```

## Related Projects

|                       Crate Name                        |                          Description                          | Memory Management Approach | `deref` or `as_str` |    Offset Representation     | Allow Weak References |
| :-----------------------------------------------------: | :-----------------------------------------------------------: | :------------------------: | :-----------------: | :--------------------------: | :-------------------: |
|       [`substr`](https://crates.io/crates/substr)       |                     Substrings as ranges                      |       no allocation        |          N          |           `usize`            |                       |
|        [`genrc`](https://crates.io/crates/genrc)        |     Ref-counted pointers allowing to reference subobjects     |     reference counting     |          Y          |    `std::ptr::NonNull<T>`    |           Y           |
|    [`shared-string`](https://docs.rs/shared-string)     | Shared strings backed by `Rc<Box<[u8]>>` and `Arc<Box<[u8]>>` |     reference counting     |          Y          |           `usize`            |           N           |
| [`shared_slice`](https://crates.io/crates/shared_slice) |        Shared slices backed by `Rc<()>` and `Arc<()>`         |     reference counting     |          Y          |           `usize`            |           N           |
|       [`shared-vec`](https://docs.rs/shared-vec)        |   Ref-counted vectors and strings simulating `Rc` and `Arc`   |     reference counting     |                     |         `*const [T]`         |           Y           |
|                         `&str`                          |                                                               |          lifetime          |                     | data part of the fat pointer |                       |