Skip to content

Commit 7e60ca3

Browse files
authored
add pkg level doc (#3684)
1 parent 743aa80 commit 7e60ca3

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

pkg/iobuf/bufferedreaderseeker.go

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
// Package iobuf provides a buffered reading interface with seeking capabilities.
2+
//
3+
// For small amounts of data, it uses an in-memory buffer (bytes.Buffer) to store
4+
// read bytes. When the amount of data exceeds a specified threshold, it switches
5+
// to disk-based buffering using a temporary file. This approach balances memory
6+
// usage and performance, allowing efficient handling of both small and large data streams.
17
package iobuf
28

39
import (

0 commit comments

Comments
 (0)