reader

Documentation

Index

• Constants
• type Reader
  • func NewReader(r io.Reader, shouldSkipBOM bool) (bomReader *Reader, err error)
  • func (br *Reader) Close() (err error)
  • func (br *Reader) GetEncodings() (encodings []bom.Encoding)
  • func (br *Reader) Read(dst []byte) (n int, err error)

Constants

const (
	ErrEncodingIsNotCertain = "encoding is not certain: %v"
	ErrDataIsBuffered       = "data is buffered"
)

Types

type Reader

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

Reader is a reader capable of guessing the encoding of a stream. The reader is single-threaded, i.e. it does not support concurrency.

func NewReader

func NewReader(r io.Reader, shouldSkipBOM bool) (bomReader *Reader, err error)

func (*Reader) Close

func (br *Reader) Close() (err error)

Close closes the reader. It is a standard method for the 'io.Closer' interface.

func (*Reader) GetEncodings

func (br *Reader) GetEncodings() (encodings []bom.Encoding)

GetEncodings returns the list of encodings detected in the data stream.

func (*Reader) Read

func (br *Reader) Read(dst []byte) (n int, err error)

Read reads data from the stream. It is a standard method for the 'io.Reader' interface.