buffer

README

buffer

buffer implementation with sugar

Documentation

Overview

Package buffer - имплементация буфера с добавлением сахара и возможностью что-то менять

Index

• Constants
• type Buffer
  • func NewBuffer() *Buffer
  • func Reader(reader io.Reader) *Buffer
  • func (b *Buffer) CancelDetects()
  • func (b *Buffer) Close() error
  • func (b *Buffer) Closed() bool
  • func (b *Buffer) Contents() []byte
  • func (b *Buffer) Detect(desired string, args ...interface{}) chan bool
  • func (b *Buffer) Read(d []byte) (int, error)
  • func (b *Buffer) Write(p []byte) (n int, err error)

Constants

const (
	// ErrReadClosedBuffer - ошибка попытки чтения и з закрытого буфера
	ErrReadClosedBuffer = errors.Const("attempt to read from closed buffer")
	// ErrWriteClosedBuffer - ошибка попытки записи в закрытый буфер
	ErrWriteClosedBuffer = errors.Const("attempt to write to closed buffer")
)

Types

type Buffer

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

Buffer буфер

func NewBuffer

func NewBuffer() *Buffer

NewBuffer - конструктор буфера

func Reader

func Reader(reader io.Reader) *Buffer

Reader - враппер ридера

func (*Buffer) CancelDetects

func (b *Buffer) CancelDetects()

CancelDetects - закрывает детектор поиска и его горутины

func (*Buffer) Close

func (b *Buffer) Close() error

Close - закрывает буфер

func (*Buffer) Closed

func (b *Buffer) Closed() bool

Closed - возвращает признак того что буфер закрыт

func (*Buffer) Contents

func (b *Buffer) Contents() []byte

Contents возвращает содержимое буфера полностью

func (*Buffer) Detect

func (b *Buffer) Detect(desired string, args ...interface{}) chan bool

Detect - поиск в буфере на совпадение искомого значения в потоке байт проходящих через буфер

select { case <-buffer.Detect("You are not logged in"):

//log in

case <-buffer.Detect("Success"):

//carry on

case <-time.After(time.Second):

	//welp
}

buffer.CancelDetects()

func (*Buffer) Read

func (b *Buffer) Read(d []byte) (int, error)

Read - чтение из буфера

func (*Buffer) Write

func (b *Buffer) Write(p []byte) (n int, err error)

Write - запись в буфер