aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar Runxi Yu2026-03-06 15:30:22 +0800
committerGravatar Runxi Yu2026-03-06 15:30:22 +0800
commit736d582dd66ad69f3aa48ce42110f58c72543363 (patch)
tree1d6279ef0f3430c5cdf4334bcb4acf1493e3a8a7
parentobjectstore: Add notes on a Cursor (diff)
signatureNo signature
format/pktline: Advise supplying a buffered reader v0.1.64
-rw-r--r--format/pktline/decoder.go2
1 files changed, 2 insertions, 0 deletions
diff --git a/format/pktline/decoder.go b/format/pktline/decoder.go
index dd40de1d..898d8ad6 100644
--- a/format/pktline/decoder.go
+++ b/format/pktline/decoder.go
@@ -14,6 +14,8 @@ type ReadOptions struct {
// Decoder reads pkt-line frames from an io.Reader.
//
+// It is advisable to supply a buffered reader.
+//
// It preserves frame boundaries and supports one-frame lookahead via PeekFrame.
type Decoder struct {
r io.Reader