heaparray 0.4.0

Heap-allocated array with optional metadata field
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

use super::generic::RcArray;
use super::ref_counters::{ArcStruct, RcStruct};
use crate::base::{AtomicPtrArray, FatPtrArray, ThinPtrArray};

/// Atomically reference counted array, referenced using a fat pointer.
///
/// See the documentation for `heaparray::naive_rc::generic::RcArray`
/// for more information on API.
pub type FpArcArray<E, L> = RcArray<FatPtrArray<E, ArcStruct<L>>, ArcStruct<L>, E, L>;

/// Reference counted array, referenced using a fat pointer.
///
/// See the documentation for `heaparray::naive_rc::generic::RcArray`
/// for more information on API.
pub type FpRcArray<E, L> = RcArray<FatPtrArray<E, RcStruct<L>>, RcStruct<L>, E, L>;

/// Atomically reference counted array, referenced using a raw pointer.
///
/// See the documentation for `heaparray::naive_rc::generic::RcArray`
/// for more information on API.
pub type TpArcArray<E, L> = RcArray<ThinPtrArray<E, ArcStruct<L>>, ArcStruct<L>, E, L>;

/// Reference counted array, referenced using a raw pointer.
///
/// See the documentation for `heaparray::naive_rc::generic::RcArray`
/// for more information on API.
pub type TpRcArray<E, L> = RcArray<ThinPtrArray<E, RcStruct<L>>, RcStruct<L>, E, L>;

/// Atomically reference counted array, referenced using a raw pointer.
///
/// See the documentation for `heaparray::naive_rc::generic::RcArray`
/// for more information on API. Note that this implementation satisfies the
/// trait bound requirements for AtomicArrayRef, so you can alter its pointer
/// atomically:
///
/// Note that this implementation satisfies
/// the trait bound requirements for `AtomicArrayRef`, and so you can
/// alter its pointer atomically:
///
/// ```rust
/// use heaparray::naive_rc::*;
/// use core::sync::atomic::Ordering;
/// let array = AtArcArray::new(100, |_| 12);
/// let other = AtArcArray::new(100, |_| 13);
/// let array_ref = array.as_ref();
/// let result = array.compare_and_swap(array_ref, other, Ordering::Relaxed);
/// ```
pub type AtArcArray<E, L> = RcArray<AtomicPtrArray<E, ArcStruct<L>>, ArcStruct<L>, E, L>;