Skip to content

Commit 3e5ece8

Browse files
authored
inout: fix safety pre-conditions list in InOutBufReserved::from_raw docs (#1502)
1 parent 2afc28d commit 3e5ece8

2 files changed

Lines changed: 7 additions & 0 deletions

File tree

inout/CHANGELOG.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
44
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
55
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
66

7+
## 0.2.3 (UNRELEASED)
8+
### Fixed
9+
- List of safety pre-conditions in `InOutBufReserved::from_raw` docs ([#1502])
10+
11+
[#1502]: https://github.com/RustCrypto/utils/pull/1502
12+
713
## 0.2.2 (2025-12-27)
814
### Changed
915
- Require `block-padding` v0.4.2 ([#1291])

inout/src/reserved.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ impl<T> InOutBufReserved<'_, '_, T> {
5252
/// must be valid for both reads and writes for `out_len * mem::size_of::<T>()`
5353
/// many bytes.
5454
/// - `in_ptr` and `out_ptr` must be either equal or non-overlapping.
55+
/// - `in_len` must be less than or equal to `out_len` (i.e. `in_len <= out_len`).
5556
/// - If `in_ptr` and `out_ptr` are equal, then the memory referenced by
5657
/// them must not be accessed through any other pointer (not derived from
5758
/// the return value) for the duration of lifetime 'a. Both read and write

0 commit comments

Comments
 (0)