File tree Expand file tree Collapse file tree 2 files changed +9
-6
lines changed Expand file tree Collapse file tree 2 files changed +9
-6
lines changed Original file line number Diff line number Diff line change @@ -14,9 +14,8 @@ only memory guaranteed is your program's image in memory as provided by the
14
14
loader. Possible use cases are OS-less development, embedded, bootloaders (even
15
15
stage0/1).
16
16
17
- Possible use cases are OS-less development, embedded, bootloaders (even
18
- stage0/1 maybe, totally untested). The primary goals are similar to the
19
- standard library simplicity, and correctness, and minimal assumptions.
17
+ The primary goals are similar to the standard library simplicity, and
18
+ correctness, and minimal assumptions.
20
19
21
20
## Usage
22
21
Original file line number Diff line number Diff line change 2
2
//!
3
3
//! Provides an allocator for extremely resource constrained environments where the only memory
4
4
//! guaranteed is your program's image in memory as provided by the loader. Possible use cases are
5
- //! OS-less development, embedded, bootloaders (even stage0/1 maybe, totally untested ).
5
+ //! OS-less development, embedded, bootloaders (even stage0/1).
6
6
//!
7
+ //! The allocator does not support meaningful deallocation but the whole allocator itself can be
8
+ //! reset by mutable reference. This is useful for a local, single thread allocator. It's
9
+ //! recommended to use the global instance to split resources _once_ at startup and then utilize
10
+ //! multiple local allocators for actual working memory. See [`doc`] for some use case studies with
11
+ //! examples.
7
12
//!
8
13
//! ## Usage – Global allocator
9
14
//!
35
40
//! dynamic values without accidentally exposing or using uninitialized memory. This allows
36
41
//! obtaining `&'static mut T` instances which is handy if a struct requires a mutable reference
37
42
//! but it is also required that this struct has `'static` lifetime bounds itself.
38
-
39
- // Copyright 2019 Andreas Molzer
43
+ // Copyright 2019,2022 Andreas Molzer
40
44
#![ no_std]
41
45
#![ deny( missing_docs) ]
42
46
You can’t perform that action at this time.
0 commit comments