README
¶
buffer
This package provides a circular buffer implementation backed by an MMAP'd file. It's purpose is to provide a simple interface for storing arbitrary records backed by a file which can handle failures and is suitable for concurrent access.
Specifically, this is a fork of ashishgandhi's buffer implementation which suits our needs more effectively. Namely, insertions into a full buffer do not overwrite existing records. Instead an error is returned to the caller forcing a decision on how to handle.
At this time, Cloudflare provides no guarantees about the stability of this package. Please use vendoring to maintain this dependency in your project.
Documentation
¶
Overview ¶
package buffer provides an mmap'd circular buffer
Index ¶
Constants ¶
This section is empty.
Variables ¶
var (
ErrNotOpen = errors.New("Not open")
)
Functions ¶
This section is empty.
Types ¶
type Buffer ¶
func New ¶
New creates a new Buffer backed by the file given by filename. it's max capacity is set to the capacity given
func (*Buffer) Insert ¶
Insert inserts the data into the buffer Inserting data which will overflow the buffer fails Inserting does not overwrite any existing data inside the buffer if it would overwrite data, errOverwrite is returned
func (*Buffer) Peek ¶
Peek reads the first record and returns it without removing it from the buffer.
Source Files
Directories