Skip to content

Commit

Permalink
fix: Fix doc comment for read_offset
Browse files Browse the repository at this point in the history
  • Loading branch information
fasterthanlime committed Mar 16, 2024
1 parent 66c4bfc commit 820f35f
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions rc-zip/src/fsm/archive.rs
Original file line number Diff line number Diff line change
Expand Up @@ -489,8 +489,9 @@ impl Buffer {
self.buffer.consume(size);
}

/// computes an absolute offset, given an offset relative
/// to the current read position
/// adds already-read bytes to the given offset. this is useful in
/// [ArchiveFsm], when we read records at fixed offsets within the file,
/// that possibly take several reads to fully parse.
pub(crate) fn read_offset(&self, offset: u64) -> u64 {
self.read_bytes + offset
}
Expand Down

0 comments on commit 820f35f

Please sign in to comment.