memkit 0.2.0-beta.1

Deterministic, intent-driven memory allocation for systems requiring predictable performance
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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112

<div align="center">

# ◈ MEMKIT CORE ◈


### `[ DETERMINISTIC CPU ALLOCATION ENGINE ]`


[![Crates.io](https://img.shields.io/badge/crates.io-v0.2.0--beta.1-00ff9f?style=for-the-badge&labelColor=0d1117)](https://crates.io/crates/memkit)
[![Documentation](https://img.shields.io/badge/docs.rs-memkit-ff00ff?style=for-the-badge&labelColor=0d1117)](https://docs.rs/memkit)
[![License](https://img.shields.io/badge/license-MPL--2.0-ff6b35?style=for-the-badge&labelColor=0d1117)](../LICENSE.md)
[![Rust](https://img.shields.io/badge/rust-1.70+-00ff9f?style=for-the-badge&logo=rust&labelColor=0d1117)](https://www.rust-lang.org/)

---

```
 ██████╗ ██████╗ ██████╗ ███████╗
██╔════╝██╔═══██╗██╔══██╗██╔════╝
██║     ██║   ██║██████╔╝█████╗  
██║     ██║   ██║██╔══██╗██╔══╝  
╚██████╗╚██████╔╝██║  ██║███████╗
 ╚═════╝ ╚═════╝ ╚═╝  ╚═╝╚══════╝
```

> *"Predictable memory is the foundation of reliable systems."*

**The core engine of the Memkit ecosystem, providing thread-local arenas, object pools, and sub-nanosecond allocation logic.**

[`◈ QUICK START`](#◈-quick-start) • [`◈ ADVANTAGE`](#◈-the-memkit-advantage) • [`◈ SENTINEL`](#◈-sentinel-mode)

</div>

---

## ◈ THE MEMKIT ADVANTAGE


| Feature | Standard `Box` | Memkit Core | System Impact |
|:--------|:--------------:|:-----------:|:--------------|
| **Cost** | O(Varies) | **O(1)** | Stable frame times |
| **Locality** | Random | **Contiguous** | SIMD/Cache efficient |
| **Safety** | Drop-based | **Bulk Reset** | Zero-cost cleanup |
| **Threads** | Contention | **Lock-Free** | Linear scaling |
| **Debug** | Standard | **Sentinel** | Hazard detection |

---

## ◈ SENTINEL MODE


Enable the `sentinel` feature for memory hardening.

```toml
[dependencies]
memkit = { version = "0.2.0-beta.1", features = ["sentinel"] }
```

```
┌─────────────────────────────────────────────────────────────────────────┐
│  ◆ POISONING   │  Fills allocs with 0xAA and frees with 0xDD. Catch      │
│                │  use-after-free instantly.                               │
├─────────────────────────────────────────────────────────────────────────┤
│  ◆ HAZARDS     │  Runtime reporting of double-frees and cross-thread     │
│                │  ownership violations.                                  │
├─────────────────────────────────────────────────────────────────────────┤
│  ◆ AUDIT       │  Verifies zero leaks on shutdown with detailed report.  │
└─────────────────────────────────────────────────────────────────────────┘
```

---

## ◈ QUICK START


```rust
use memkit::{MkAllocator, MkConfig};

let alloc = MkAllocator::new(MkConfig::default());

loop {
    alloc.begin_frame();
    
    // O(1) Allocation - zero fragmentation
    let buffer = alloc.frame_slice::<f32>(1024).unwrap();
    let entity = alloc.frame_box(PhysicsEntity::new()).unwrap();
    
    // Pool allocation for stable objects
    let pool_obj = alloc.pool_box(Component::new()).unwrap();
    
    alloc.end_frame(); // Bulk reset
}
```

---

## ◈ ECOSYSTEM


| Crate | Purpose | Status |
|:------|:--------|:-------|
| `memkit` | Core engine | **BETA 1.1** |
| [`memkit-gpu`](../memkit-gpu) | GPU Buffer Management | **BETA 1.1** |
| [`memkit-co`](../memkit-co) | CPU↔GPU Synchronization | **BETA 1.1** |
| [`memkit-async`](../memkit-async) | Task-local Async Safety | **BETA 1.1** |

---

## ◈ LICENSE


Licensed under the **Mozilla Public License 2.0**.

---

<div align="center">

**[ Part of the ◈ MEMKIT ◈ Ecosystem ]**

</div>