musli_core/alloc/
raw_vec.rs

Help
1/// A raw buffer allocated through an [`Allocator`].
2///
3/// [`Allocator`]: super::Allocator
4///
5/// ## Examples
6///
7/// ```
8/// use musli::alloc::{Allocator, RawVec};
9///
10/// let values: [u32; 4] = [1, 2, 3, 4];
11///
12/// musli::alloc::default!(|alloc| {
13///     let mut buf = alloc.new_raw_vec::<u32>();
14///     let mut len = 0;
15///
16///     for value in values {
17///         if !buf.resize(len, 1) {
18///             panic!("Allocation failed");
19///         }
20///
21///         // SAFETY: We've just resized the above buffer.
22///         unsafe {
23///             buf.as_mut_ptr().add(len).write(value);
24///         }
25///
26///         len += 1;
27///     }
28///
29///     // SAFETY: Slice does not outlive the buffer it references.
30///     let bytes = unsafe { core::slice::from_raw_parts(buf.as_ptr(), len) };
31///     assert_eq!(bytes, values);
32/// });
33/// ```
34pub trait RawVec<T> {
35    /// Resize the buffer.
36    fn resize(&mut self, len: usize, additional: usize) -> bool;
37
38    /// Get a pointer into the buffer.
39    fn as_ptr(&self) -> *const T;
40
41    /// Get a mutable pointer into the buffer.
42    fn as_mut_ptr(&mut self) -> *mut T;
43
44    /// Try to merge one buffer with another.
45    ///
46    /// The two length parameters refers to the initialized length of the two
47    /// buffers.
48    ///
49    /// If this returns `Err(B)` if merging was not possible.
50    fn try_merge<B>(&mut self, this_len: usize, other: B, other_len: usize) -> Result<(), B>
51    where
52        B: RawVec<T>;
53}
musli_core/alloc/raw_vec.rs

musli_core/alloc/
raw_vec.rs
