buffer

Documentation

Index

• func Gap(buf Buffer) int64
• type Buffer
• type BufferAt
  • func New(n int64) BufferAt

Functions

func Gap

func Gap(buf Buffer) int64

Gap returns buf.Cap() - buf.Len()

Types

type Buffer

type Buffer interface {
	Len() int64 // How much data is Buffered in bytes
	Cap() int64 // How much data can be Buffered at once in bytes.
	io.Reader   // Read() will read from the top of the buffer [io.EOF if empty]
	io.Writer   // Write() will write to the end of the buffer [io.ErrShortWrite if not enough space]
	Reset()     // Truncates the buffer, Len() == 0.
}

Buffer is used to Write() data which will be Read() later.

type BufferAt

type BufferAt interface {
	Buffer
	io.ReaderAt
	io.WriterAt
}

BufferAt is a buffer which supports io.ReaderAt and io.WriterAt

func New

func New(n int64) BufferAt

New returns a new in memory BufferAt with max size N. It's backed by a bytes.Buffer.