buffile

Documentation

Overview

package buffile helps batch write by writes to the tempobary in-memory buffer under the assumption that many writes come in to the part of single file frequently.

Index

• type BufferedFile
  • func New(filePath string) (*BufferedFile, error)
  • func (f *BufferedFile) Close() error
  • func (f *BufferedFile) WriteAt(data []byte, offset int64) (int, error)

Types

type BufferedFile

type BufferedFile struct {
	// contains filtered or unexported fields
}

BufferedFile abstracts a file with block-sized buffer to group writes that are likely consective. This object does not provide any mean of concurrency guarantee. Also note that the underlying file is assumed to have the content already written on disk, and the behavior on writing beyond the file size is not defined.

func New

func New(filePath string) (*BufferedFile, error)

func (*BufferedFile) Close

func (f *BufferedFile) Close() error

func (*BufferedFile) WriteAt

func (f *BufferedFile) WriteAt(data []byte, offset int64) (int, error)

WriteAt writes the data at offset from the beginning of the file. Upon the return from this call, the data does not reach to disk yet. Make sure to close BufferedFile f to write the data on disk.