devela_base_alloc 0.26.0

base alloc shared functionality for devela
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
59

// devela_base_alloc::data::layout::buffer::examples
//
// TOC
// - BufferAllocExample
//
// NOTES
// - doclinks use #method notation to ensure they wont link to /zall version.

use crate::buffer_linear;

buffer_linear!(
    #[doc = crate::_tags!(example data_structure)]
    /// An owned linear buffer over a [`Vec`], made with [`buffer_linear!`].
    #[doc = crate::_doc_location!("data/layout")]
    ///
    /// # Methods
    ///
    /// - [Dynamically sized array](#impl-BufferAllocExample<T,+Vec<T>>)
    /// (`vec`)
    ///   - Constructors:
    ///     [`new`](#method.new) *([_init](#method.new_init))*,
    ///     [`with_capacity`](#method.with_capacity) *([_prim](#method.with_capacity_prim))*.
    ///   - Size:
    ///     [`len`](#method.len) *([_prim](#method.len_prim))*,
    ///     [`is_empty`](#method.is_empty),
    ///   - Capacity:
    ///     [`capacity`](#method.capacity) *([_prim](#method.capacity_prim))*,
    ///     [`remaining_capacity`](#method.remaining_capacity)
    ///       *([_prim](#method.remaining_capacity_prim))*,
    ///     [`is_full`](#method.is_full).
    ///   - Logical range control:
    ///     [`clear`](#method.clear),
    ///     [`truncate`](#method.truncate), *([_prim](#method.truncate_prim))*.
    ///   - Push:
    ///     [`push_back`](#method.push_back),
    ///     [`push_slice`](#method.push_slice).
    ///   - Pop:
    ///     [`pop_back`](#method.pop_back).
    ///   - Peek:
    ///     [`peek_back`](#method.peek_back) *([_mut](#method.peek_mut_back))*.
    ///   - Get:
    ///     [`get`](#method.get) *([_mut](#method.get_mut))*.
    ///   - Take:
    ///     [`take_default`](#method.take_default),
    ///     [`take_init`](#method.take_init),
    ///     [`take_with`](#method.take_with), *([_copy](#method.take_with_copy))*.
    ///   - Views:
    ///     [`as_slice`](#method.as_slice) *([_mut](#method.as_mut_slice))*,
    // %common_iter_visit:
    ///   - Iteration:
    ///     [`iter`](#method.iter) *([_mut](#method.iter_mut))*.
    ///   - Visitation:
    ///     [`visit_each`](#method.visit_each) *([_mut](#method.visit_each_mut))*,
    ///     [`visit_slice`](#method.visit_slice) *([_mut](#method.visit_mut_slice))*.
    #[cfg_attr(nightly_doc, doc(cfg(feature = "alloc")))]
    #[cfg_attr(nightly_doc, doc(cfg(feature = "_docs_examples")))]
    pub struct BufferAllocExample: alloc (crate::NonValueU8<{u8::MAX}>);
    vec,
);