aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authoriximeow <me@iximeow.net>2024-06-22 11:52:13 -0700
committeriximeow <me@iximeow.net>2024-06-22 11:52:13 -0700
commit872adb302b1c51cda7b1e99e128129e230e24ff8 (patch)
tree027852478066299e47a14a2045c020244b219b53 /src
parent34b3cb568fb8aa2f326ab0ecd8384762aa14ed03 (diff)
update changelog, adjust doc emphasis
Diffstat (limited to 'src')
-rw-r--r--src/reader.rs5
1 files changed, 3 insertions, 2 deletions
diff --git a/src/reader.rs b/src/reader.rs
index 028d835..8b68486 100644
--- a/src/reader.rs
+++ b/src/reader.rs
@@ -24,8 +24,9 @@ pub enum ReadError {
/// isn't a multiple of 8 bits, `U8Reader` won't be sufficient.
pub trait Reader<Address, Item> {
fn next(&mut self) -> Result<Item, ReadError>;
- /// read `buf`-many items from this reader in bulk. if `Reader` cannot read `buf`-many items,
- /// return `ReadError::ExhaustedInput`.
+ /// read `buf`-many items from this reader in bulk.
+ ///
+ /// if `Reader` cannot read `buf`-many items, return `ReadError::ExhaustedInput`.
fn next_n(&mut self, buf: &mut [Item]) -> Result<(), ReadError>;
/// mark the current position as where to measure `offset` against.
fn mark(&mut self);