ircreader

Documentation

Index

• Variables
• type Reader
  • func NewIRCReader(conn io.Reader) *Reader
  • func (cc *Reader) Initialize(conn io.Reader, initialSize, maxSize int)
  • func (cc *Reader) ReadLine() ([]byte, error)

Variables

var (
	ErrReadQ = errors.New("readQ exceeded (read too many bytes without terminating newline)")
)

Types

type Reader

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

func NewIRCReader

func NewIRCReader(conn io.Reader) *Reader

NewIRCReader Returns a new *Reader with sane buffer size limits.

func (*Reader) Initialize

func (cc *Reader) Initialize(conn io.Reader, initialSize, maxSize int)

Initialize "Placement new" for a Reader; initializes it with custom buffer size limits.

func (*Reader) ReadLine

func (cc *Reader) ReadLine() ([]byte, error)

ReadLine Blocks until a full IRC line is read, then returns it. Accepts either \n or \r\n as the line terminator (but not \r in isolation). Passes through errors from the underlying connection. Returns ErrReadQ if the buffer limit was exceeded without a terminating \n.