File tree Expand file tree Collapse file tree 1 file changed +5
-3
lines changed Expand file tree Collapse file tree 1 file changed +5
-3
lines changed Original file line number Diff line number Diff line change @@ -13,9 +13,11 @@ use mem_dbg::{MemDbg, MemSize};
13
13
/// An aligned version of [`Cursor`](std::io::Cursor).
14
14
///
15
15
/// The standard library implementation of a [cursor](std::io::Cursor) is not
16
- /// aligned, and thus cannot be used to create examples or unit tests for
17
- /// ε-serde. This version has a [settable alignment](maligned::Alignment) that
18
- /// is guaranteed to be respected by the underlying storage.
16
+ /// aligned, meaning that its length is exactly the number of bytes written.
17
+ /// Thus cannot be used to create examples or unit tests for ε-serde.
18
+ /// This version has a [settable alignment](maligned::Alignment) that
19
+ /// is guaranteed to be respected by the underlying storage, by adding padding
20
+ /// bytes at the end of the underlying vector.
19
21
///
20
22
/// Note that length and position are stored as `usize` values, so the maximum
21
23
/// length and position are `usize::MAX`. This is different from
You can’t perform that action at this time.
0 commit comments