textbuffer

Documentation

Overview

Package textbuffer provides (as a first rough prototype) handling of cached byte buffers.

Clients create a *TextBuffer, which caches portions of bytes of an io.ReaderAt. The text buffer implements io.ReaderAt itself, thus may be used in the same fashion as the underlying reader.

reader := strings.NewReader("The quick brown fox jumps over the lazy dog.")
cache := textbuffer.NewCache(reader, 3)
bytebuf := make([]byte, 10)
n, err := cache.ReadAt(bytebuf, 4) // reads "quick..."

Index

• Constants
• type TextBuffer
  • func NewBuffer() *TextBuffer
  • func (tbuf *TextBuffer) String() string
• type TextCache
  • func NewCache(reader io.ReaderAt, buffercount int) *TextCache
  • func (cache *TextCache) Dump()
  • func (cache *TextCache) ReadAt(buffer []byte, offset int64) (N int, err error)

Constants

const BufferSize = 10

const DefaultCacheBufferCount = 3

const RecycleTimeout = 2 * time.Second

const RecycleTimeout = time.Minute

Types

type TextBuffer

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

func NewBuffer

func NewBuffer() *TextBuffer

Create a text buffer. Will use DefaultBufferSize, if buffersize is 0.

func (*TextBuffer) String

func (tbuf *TextBuffer) String() string

type TextCache

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

func NewCache

func NewCache(reader io.ReaderAt, buffercount int) *TextCache

func (*TextCache) Dump

func (cache *TextCache) Dump()

func (*TextCache) ReadAt

func (cache *TextCache) ReadAt(buffer []byte, offset int64) (N int, err error)