Skip to content

Commit beed516

Browse files
committed
update documentation after removing ByteValued
Signed-off-by: Julian Schindel <mail@arctic-alpaca.de>
1 parent 44de453 commit beed516

2 files changed

Lines changed: 9 additions & 16 deletions

File tree

CHANGELOG.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# Changelog
22

3+
## Upcoming Release
4+
5+
## Removed
6+
7+
- [...] Removed `ByteValued` trait and `endian` module in favor of the `zerocopy` crate.
8+
`ByteValued`'s functionality is now provided by `zerocopy::IntoBytes`, `zerocopy::FromBytes` and `zerocopy::Zeroed`.
9+
`ByteValued::as_bytes` can be replaced with `VolatileSlices::from` for `&mut [u8]`.
10+
311
## 0.18.0
412

513
### Changed

DESIGN.md

Lines changed: 1 addition & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -35,12 +35,11 @@ The `vm-memory` is derived from two upstream projects:
3535
The high level abstraction of the VM memory has been heavily refactored to
3636
provide a VMM agnostic interface.
3737

38-
The `vm-memory` crate could be divided into four logic parts as:
38+
The `vm-memory` crate could be divided into three logic parts as:
3939

4040
- [Abstraction of Address Space](#abstraction-of-address-space)
4141
- [Specialization for Virtual Machine Physical Address Space](#specialization-for-virtual-machine-physical-address-space)
4242
- [Backend Implementation Based on `mmap`](#backend-implementation-based-on-mmap)
43-
- [Utilities and helpers](#utilities-and-helpers)
4443

4544
### Address Space Abstraction
4645

@@ -146,20 +145,6 @@ object to translate I/O virtual addresses (IOVAs) into VMM user addresses
146145
(VUAs), which are then passed to the inner `GuestMemoryBackend`
147146
implementation (like `GuestMemoryMmap`).
148147

149-
### Utilities and Helpers
150-
151-
The following utilities and helper traits/macros are imported from the
152-
[crosvm project](https://chromium.googlesource.com/chromiumos/platform/crosvm/)
153-
with minor changes:
154-
155-
- `ByteValued` (originally `DataInit`): types which are safe to be initialized
156-
from raw data. A type `T` is `ByteValued` if and only if it can be
157-
initialized by reading its contents from a byte array. This is generally true
158-
for all plain-old-data structs. It is notably not true for any type that
159-
includes a reference.
160-
- `{Le,Be}_{16,32,64}`: explicit endian types useful for embedding in structs
161-
or reinterpreting data.
162-
163148
## Relationships between Traits, Structs and Types
164149

165150
**Traits**:

0 commit comments

Comments
 (0)