bufferqueue

README

bufferqueue

import (
    "github.com/xen0n/bufferqueue" // package bufferqueue
)

A simple single-producer single-consumer buffer queue that only copies its incoming data once, for every Read() from it. Zero-copy is not possible given the semantic of io.Reader.

Beware: This implementation might be extremely buggy, do not put into production yet without much testing.

License

• MIT

Documentation

Index

• type BBQ
  • func New() *BBQ
  • func (b *BBQ) MarkEOF()
  • func (b *BBQ) QueueBuffer(buf []byte)
  • func (b *BBQ) Read(p []byte) (n int, err error)

Types

type BBQ

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

BBQ is a byte buffer queue that only copies data when it is read. The zero value of a BBQ is ready to use. This type is not designed for multi-producer or multi-consumer use.

func New

func New() *BBQ

func (*BBQ) MarkEOF

func (b *BBQ) MarkEOF()

func (*BBQ) QueueBuffer

func (b *BBQ) QueueBuffer(buf []byte)

func (*BBQ) Read

func (b *BBQ) Read(p []byte) (n int, err error)