user0/rust
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #4338 from RalfJung/FileDescription

Browse source 
FileDescription: improve read/write docs
This commit is contained in:
Ralf Jung 2025-05-21 14:57:41 +00:00 • committed by GitHub
commit febe98807f
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 8 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

10
src/tools/miri/src/shims/files.rs
View file

@ -135,7 +135,10 @@ pub trait FileDescription: std::fmt::Debug + FileDescriptionExt {
/// Reads as much as possible into the given buffer `ptr`.
/// `len` indicates how many bytes we should try to read.
/// `dest` is where the return value should be stored: number of bytes read, or `-1` in case of error.
///
/// When the read is done, `finish` will be called. Note that `read` itself may return before
/// that happens! Everything that should happen "after" the `read` needs to happen inside
/// `finish`.
fn read<'tcx>(
self: FileDescriptionRef<Self>,
_communicate_allowed: bool,
@ -149,7 +152,10 @@ pub trait FileDescription: std::fmt::Debug + FileDescriptionExt {
/// Writes as much as possible from the given buffer `ptr`.
/// `len` indicates how many bytes we should try to write.
/// `dest` is where the return value should be stored: number of bytes written, or `-1` in case of error.
///
/// When the write is done, `finish` will be called. Note that `write` itself may return before
/// that happens! Everything that should happen "after" the `write` needs to happen inside
/// `finish`.
fn write<'tcx>(
self: FileDescriptionRef<Self>,
_communicate_allowed: bool,