reader

README

Reader

A simple library to work with io.Reader.

This package offers a convenient line reader for a specific line format.

Documentation

Index

• Constants
• type Reader
  • func NewReader(reader io.Reader) *Reader
  • func (r *Reader) GetInternalReader() io.Reader
  • func (r *Reader) Read(dst []byte) (n int, err error)
  • func (r *Reader) Read2Bytes() (bytes []byte, err error)
  • func (r *Reader) Read4Bytes() (bytes []byte, err error)
  • func (r *Reader) Read8Bytes() (bytes []byte, err error)
  • func (r *Reader) ReadByte() (ub byte, err error)
  • func (r *Reader) ReadBytes(size int) (bytes []byte, err error)
  • func (r *Reader) ReadDWord_BE() (dw bt.DWord, err error)
  • func (r *Reader) ReadDWord_LE() (dw bt.DWord, err error)
  • func (r *Reader) ReadDouble_BE() (d float64, err error)
  • func (r *Reader) ReadDouble_LE() (d float64, err error)
  • func (r *Reader) ReadFloat_BE() (f float32, err error)
  • func (r *Reader) ReadFloat_LE() (f float32, err error)
  • func (r *Reader) ReadLineEndingWithCRLF() ([]byte, error)
  • func (r *Reader) ReadSByte() (sb int8, err error)
  • func (r *Reader) ReadSLong_BE() (sl int32, err error)
  • func (r *Reader) ReadSLong_LE() (sl int32, err error)
  • func (r *Reader) ReadSShort_BE() (ss int16, err error)
  • func (r *Reader) ReadSShort_LE() (ss int16, err error)
  • func (r *Reader) ReadULong_BE() (ul uint32, err error)
  • func (r *Reader) ReadULong_LE() (ul uint32, err error)
  • func (r *Reader) ReadUShort_BE() (us uint16, err error)
  • func (r *Reader) ReadUShort_LE() (us uint16, err error)
  • func (r *Reader) ReadWord_BE() (w bt.Word, err error)
  • func (r *Reader) ReadWord_LE() (w bt.Word, err error)

Constants

const (
	CR = '\r'
	LF = '\n'
)

ASCII symbols.

const ErrUnexpectedDataSize = "unexpected data size: %v vs %v"

Types

type Reader

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

func NewReader

func NewReader(
	reader io.Reader,
) *Reader

func (*Reader) GetInternalReader

func (r *Reader) GetInternalReader() io.Reader

func (*Reader) Read

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

func (*Reader) Read2Bytes

func (r *Reader) Read2Bytes() (bytes []byte, err error)

Read2Bytes reads two bytes.

func (*Reader) Read4Bytes

func (r *Reader) Read4Bytes() (bytes []byte, err error)

Read4Bytes reads four bytes.

func (*Reader) Read8Bytes

func (r *Reader) Read8Bytes() (bytes []byte, err error)

Read8Bytes reads eight bytes.

func (*Reader) ReadByte

func (r *Reader) ReadByte() (ub byte, err error)

ReadByte reads one (unsigned) byte.

func (*Reader) ReadBytes

func (r *Reader) ReadBytes(size int) (bytes []byte, err error)

ReadBytes reads an exact number of bytes.

func (*Reader) ReadDWord_BE

func (r *Reader) ReadDWord_BE() (dw bt.DWord, err error)

ReadDWord_BE reads a double word using the big endian technique.

func (*Reader) ReadDWord_LE

func (r *Reader) ReadDWord_LE() (dw bt.DWord, err error)

ReadDWord_LE reads a double word using the little endian technique.

func (*Reader) ReadDouble_BE

func (r *Reader) ReadDouble_BE() (d float64, err error)

ReadDouble_BE reads a Double using the big endian technique.

func (*Reader) ReadDouble_LE

func (r *Reader) ReadDouble_LE() (d float64, err error)

ReadDouble_LE reads a Double using the little endian technique.

func (*Reader) ReadFloat_BE

func (r *Reader) ReadFloat_BE() (f float32, err error)

ReadFloat_BE reads a Float using the big endian technique.

func (*Reader) ReadFloat_LE

func (r *Reader) ReadFloat_LE() (f float32, err error)

ReadFloat_LE reads a Float using the little endian technique.

func (*Reader) ReadLineEndingWithCRLF

func (r *Reader) ReadLineEndingWithCRLF() ([]byte, error)

ReadLineEndingWithCRLF reads a Line ending exactly with the 'CR'+'LF' Symbols Sequence. The two Symbols at the End of the Line (CR+LF) are included into the returned Result.

func (*Reader) ReadSByte

func (r *Reader) ReadSByte() (sb int8, err error)

ReadSByte reads one signed byte.

func (*Reader) ReadSLong_BE

func (r *Reader) ReadSLong_BE() (sl int32, err error)

ReadSLong_BE reads a signed long using the big endian technique.

func (*Reader) ReadSLong_LE

func (r *Reader) ReadSLong_LE() (sl int32, err error)

ReadSLong_LE reads a signed long using the little endian technique.

func (*Reader) ReadSShort_BE

func (r *Reader) ReadSShort_BE() (ss int16, err error)

ReadSShort_BE reads a signed short using the big endian technique.

func (*Reader) ReadSShort_LE

func (r *Reader) ReadSShort_LE() (ss int16, err error)

ReadSShort_LE reads a signed short using the little endian technique.

func (*Reader) ReadULong_BE

func (r *Reader) ReadULong_BE() (ul uint32, err error)

ReadULong_BE reads an unsigned long using the big endian technique.

func (*Reader) ReadULong_LE

func (r *Reader) ReadULong_LE() (ul uint32, err error)

ReadULong_LE reads an unsigned long using the little endian technique.

func (*Reader) ReadUShort_BE

func (r *Reader) ReadUShort_BE() (us uint16, err error)

ReadUShort_BE reads an unsigned short using the big endian technique.

func (*Reader) ReadUShort_LE

func (r *Reader) ReadUShort_LE() (us uint16, err error)

ReadUShort_LE reads an unsigned short using the little endian technique.

func (*Reader) ReadWord_BE

func (r *Reader) ReadWord_BE() (w bt.Word, err error)

ReadWord_BE reads a word using the big endian technique.

func (*Reader) ReadWord_LE

func (r *Reader) ReadWord_LE() (w bt.Word, err error)

ReadWord_LE reads a word using the little endian technique.