embedded-shadow 0.1.2

Zero-alloc shadow register table with dirty tracking for embedded systems
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

# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [0.1.2] - 2026-01-09

### Added

- `load_defaults()` and `load_defaults_unchecked()` for initializing shadow table with factory/EEPROM data without marking dirty
- Example tests now run as part of `cargo test --examples`
- Comprehensive test coverage for critical areas:
  - Kernel view tests (dirty tracking, read/write behavior)
  - Host view tests (dirty marking, access policy enforcement)
  - Staging buffer tests (overlay logic, capacity limits)
  - Staged view tests (commit behavior, access policies)
  - Storage tests (`load_defaults` initialization)
- Shared `test_support` module for DRY test helpers
- Documentation for all public types, traits, and methods
- Documentation for generic parameters on `ShadowStorageBase`
- Expanded example in lib.rs and README showing typical usage patterns

### Changed

- Renamed `action()` to `commit()` on `HostViewStaged` (`action` is now deprecated)

## [0.1.1] - 2026-01-09

### Changed

- Made `KernelShadow::with_view_unchecked` unsafe
- Added `critical_section` example

## [0.1.0] - 2026-01-08

### Added

- Initial release
- Zero-allocation shadow register table with const generics
- Block-based dirty tracking with bitmap
- Dual access patterns: `HostShadow` (application) and `KernelShadow` (hardware driver)
- `HostView` for host writes that mark dirty and trigger persistence
- `KernelView` for kernel reads/writes without dirty marking
- Transactional staged writes with `HostViewStaged` and `PatchStagingBuffer`
- Configurable access policies via `AccessPolicy` trait
- Configurable persistence policies via `PersistPolicy` and `PersistTrigger` traits
- Type-safe builder pattern with `ShadowStorageBuilder`
- Critical section support for thread-safe access
- `no_std` compatible for embedded systems
- Examples: basic, staging, persist, access_policy, critical_section, complex