diff options
| author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-28 14:29:10 +0000 |
|---|---|---|
| committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-28 14:29:10 +0000 |
| commit | 2aa4a82499d4becd2284cdb482213d541b8804dd (patch) | |
| tree | b80bf8bf13c3766139fbacc530efd0dd9d54394c /third_party/rust/inplace_it/README.md | |
| parent | Initial commit. (diff) | |
| download | firefox-upstream.tar.xz firefox-upstream.zip | |
Adding upstream version 86.0.1.upstream/86.0.1upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'third_party/rust/inplace_it/README.md')
| -rw-r--r-- | third_party/rust/inplace_it/README.md | 73 |
1 files changed, 73 insertions, 0 deletions
diff --git a/third_party/rust/inplace_it/README.md b/third_party/rust/inplace_it/README.md new file mode 100644 index 0000000000..56a0f6b285 --- /dev/null +++ b/third_party/rust/inplace_it/README.md @@ -0,0 +1,73 @@ +# Inplace it!
+
+[](https://crates.io/crates/inplace_it)
+[](https://github.com/NotIntMan/inplace_it/blob/master/LICENSE.txt)
+[](https://github.com/NotIntMan/inplace_it/actions)
+
+Place small arrays on the stack with a low cost!
+
+The only price you should pay for this is the price of choosing
+a type based on the size of the requested array! This is just one `match` and `call`!
+
+## What?
+
+This crate is created for one purpose: allocating small arrays on the stack.
+The simplest way to use it is:
+
+```rust
+use inplace_it::{inplace_or_alloc_array, UninitializedSliceMemoryGuard};
+
+inplace_or_alloc_array(
+ 150, // size of needed array to allocate
+ |mut uninit_guard: UninitializedSliceMemoryGuard<u16>| { // and this is consumer of uninitialized memory
+ assert_eq!(160, uninit_guard.len());
+
+ {
+ // You can borrow guard to reuse memory
+ let borrowed_uninit_guard = uninit_guard.borrow();
+ // Let's initialize memory
+ // Note that borrowed_uninit_guard will be consumed (destroyed to produce initialized memory guard)
+ let init_guard = borrowed_uninit_guard.init(|index| index as u16 + 1);
+ // Memory not contains elements [1, 2, ..., 160]
+ // Lets check it. Sum of [1, 2, ..., 160] = 12880
+ let sum: u16 = init_guard.iter().sum();
+ assert_eq!(sum, 12880);
+ }
+
+ {
+ // If you don't want to reuse memory, you can init new guard directly
+ let init_guard = uninit_guard.init(|index| index as u16 * 2);
+ // Memory not contains elements [0, 2, 4, ..., 318]
+ // Lets check it. Sum of [0, 2, 4, ..., 318] = 25440
+ let sum: u16 = init_guard.iter().sum();
+ assert_eq!(sum, 25440);
+ }
+ }
+)
+```
+
+## Why?
+
+Because allocation on the stack (i.e. placing variables) is **MUCH FASTER** then usual
+allocating in the heap.
+
+## Moar!
+
+You can read the [API reference](https://docs.rs/inplace_it) for more details
+or create an [new issue](https://github.com/NotIntMan/inplace_it/issues/new)
+to submit a bug, feature request or just ask a question.
+
+## Release notes
+
+### 0.3.2
+* Placing of uninit memory moved out from `try_inplace_array` to disallow compiler to optimize it.
+
+### 0.3.1
+* Initialize with an exact-size iterator.
+
+### 0.3.0
+* API safety. No more unsafe external functions.
+* Drop correctness. No more dropping of uninitialized memory.
+
+### 0.2.2
+* Fixed drop-correctness for safe functions. Now unsafe function do not drop your data but safe function do it correctly.
|