diff options
| author | Matthias Krüger <matthias.krueger@famsik.de> | 2024-06-20 14:07:04 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-06-20 14:07:04 +0200 |
| commit | ef2e8bfcbfb10d54b8b8a0cdbe509783c7db5023 (patch) | |
| tree | aa2aaa1a9e1624a084668dabcb8dd65313652847 /library/std/src/io/buffered/bufreader | |
| parent | 7b91d11abb8883d903cbd09b07e022ede814b89d (diff) | |
| parent | b5a5647ee0f8af226fcc44a3e6b054fc758a785e (diff) | |
| download | rust-ef2e8bfcbfb10d54b8b8a0cdbe509783c7db5023.tar.gz rust-ef2e8bfcbfb10d54b8b8a0cdbe509783c7db5023.zip | |
Rollup merge of #126717 - nnethercote:rustfmt-use-pre-cleanups, r=jieyouxu
Clean up some comments near `use` declarations #125443 will reformat all `use` declarations in the repository. There are a few edge cases involving comments on `use` declarations that require care. This PR cleans up some clumsy comment cases, taking us a step closer to #125443 being able to merge. r? ``@lqd``
Diffstat (limited to 'library/std/src/io/buffered/bufreader')
| -rw-r--r-- | library/std/src/io/buffered/bufreader/buffer.rs | 21 |
1 files changed, 11 insertions, 10 deletions
diff --git a/library/std/src/io/buffered/bufreader/buffer.rs b/library/std/src/io/buffered/bufreader/buffer.rs index e9e29d60ca2..796137c0123 100644 --- a/library/std/src/io/buffered/bufreader/buffer.rs +++ b/library/std/src/io/buffered/bufreader/buffer.rs @@ -1,13 +1,14 @@ -///! An encapsulation of `BufReader`'s buffer management logic. -/// -/// This module factors out the basic functionality of `BufReader` in order to protect two core -/// invariants: -/// * `filled` bytes of `buf` are always initialized -/// * `pos` is always <= `filled` -/// Since this module encapsulates the buffer management logic, we can ensure that the range -/// `pos..filled` is always a valid index into the initialized region of the buffer. This means -/// that user code which wants to do reads from a `BufReader` via `buffer` + `consume` can do so -/// without encountering any runtime bounds checks. +//! An encapsulation of `BufReader`'s buffer management logic. +//! +//! This module factors out the basic functionality of `BufReader` in order to protect two core +//! invariants: +//! * `filled` bytes of `buf` are always initialized +//! * `pos` is always <= `filled` +//! Since this module encapsulates the buffer management logic, we can ensure that the range +//! `pos..filled` is always a valid index into the initialized region of the buffer. This means +//! that user code which wants to do reads from a `BufReader` via `buffer` + `consume` can do so +//! without encountering any runtime bounds checks. + use crate::cmp; use crate::io::{self, BorrowedBuf, Read}; use crate::mem::MaybeUninit; |
