Skip to content

Commit

Permalink
s2: add GetBufferCapacity() method (#832)
Browse files Browse the repository at this point in the history
Add GetBufferCapacity() method. We are reusing readers with sync.Pool
and we'd like to avoid allocating memory for the default block size
since most of the inputs are smaller. To have a better estimate of how
big the lazy buffer should be, we are thinking about keeping in mind a
running average of the internal buffer capacities. This method would
allow us to implement that.
  • Loading branch information
GiedriusS authored Jun 22, 2023
1 parent eff45bd commit 67a538e
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions s2/reader.go
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,13 @@ type Reader struct {
ignoreCRC bool
}

// GetBufferCapacity returns the capacity of the internal buffer.
// This might be useful to know when reusing the same reader in combination
// with the lazy buffer option.
func (r *Reader) GetBufferCapacity() int {
return cap(r.buf)
}

// ensureBufferSize will ensure that the buffer can take at least n bytes.
// If false is returned the buffer exceeds maximum allowed size.
func (r *Reader) ensureBufferSize(n int) bool {
Expand Down

0 comments on commit 67a538e

Please sign in to comment.