bytebuilder

README

bytebuilder

Golang API to manupilate byte slices.

Documentation

Index

• func ReadBytes(in *[]byte, n int) []byte
• func ReadReaderBytes(in io.Reader, n int) ([]byte, error)
• func ReadReaderUint16(in io.Reader) (uint16, error)
• func ReadReaderUint24(in io.Reader) (uint32, error)
• func ReadReaderUint32(in io.Reader) (uint32, error)
• func ReadReaderUint8(in io.Reader) (uint8, error)
• func ReadUint16(in *[]byte) (uint16, bool)
• func ReadUint24(in *[]byte) (uint32, bool)
• func ReadUint32(in *[]byte) (uint32, bool)
• func ReadUint8(in *[]byte) (uint8, bool)
• func Skip(in *[]byte, n int) bool
• func SkipReader(in io.Reader, n int) error
• func WriteBytes(in *[]byte, bytes ...byte)
• func WriteUint16(in *[]byte, v uint16)
• func WriteUint24(in *[]byte, v uint32)
• func WriteUint32(in *[]byte, v uint32)
• func WriteUint8(in *[]byte, v uint8)
• func WriteWriterBytes(in io.Writer, bytes ...byte) error
• func WriteWriterUint16(in io.Writer, v uint16) error
• func WriteWriterUint24(in io.Writer, v uint32) error
• func WriteWriterUint32(in io.Writer, v uint32) error
• func WriteWriterUint8(in io.Writer, v uint8) error
• type Buffer
  • func NewBuffer(bytes []byte) Buffer
  • func NewEmpty() Buffer
  • func ReadAll(r io.Reader) (Buffer, error)
  • func (b *Buffer) Bytes() []byte
  • func (b *Buffer) BytesPointer() *[]byte
  • func (b *Buffer) Empty() bool
  • func (b *Buffer) ReadBytes(n int) []byte
  • func (b *Buffer) ReadUint16() (uint16, bool)
  • func (b *Buffer) ReadUint24() (uint32, bool)
  • func (b *Buffer) ReadUint32() (uint32, bool)
  • func (b *Buffer) ReadUint8() (uint8, bool)
  • func (b *Buffer) Size() int
  • func (b *Buffer) Skip(n int) bool
  • func (b *Buffer) WriteBytes(bytes ...byte)
  • func (b *Buffer) WriteUint16(v uint16)
  • func (b *Buffer) WriteUint24(v uint32)
  • func (b *Buffer) WriteUint32(v uint32)
  • func (b *Buffer) WriteUint8(v uint8)

Functions

func ReadBytes

func ReadBytes(in *[]byte, n int) []byte

ReadBytes removes the first n bytes from in and returns it. If the read failed, returns nil.

func ReadReaderBytes

func ReadReaderBytes(in io.Reader, n int) ([]byte, error)

ReadReaderBytes reads n byte from in. At the end of the file, io.EOF is returned.

func ReadReaderUint16

func ReadReaderUint16(in io.Reader) (uint16, error)

ReadReaderUint16 reads bytes from in and returns it as an uint16. At the end of the file io.EOF returned.

func ReadReaderUint24

func ReadReaderUint24(in io.Reader) (uint32, error)

ReadReaderUint24 reads bytes from in and returns it as an uint32. At the end of the file, io.EOF is returned.

func ReadReaderUint32

func ReadReaderUint32(in io.Reader) (uint32, error)

ReadReaderUint32 reads bytes from in and returns it as an uint32. At the end of the file io.EOF returned.

func ReadReaderUint8

func ReadReaderUint8(in io.Reader) (uint8, error)

ReadReaderUint8 reads a byte from in and returns is as an uint8. At the end of the file, io.EOF is returned.

func ReadUint16

func ReadUint16(in *[]byte) (uint16, bool)

ReadUint16 removes the first bytes from in and returns it as an uint16. The bool indicates whether the read was successful.

func ReadUint24

func ReadUint24(in *[]byte) (uint32, bool)

ReadUint24 removes the first bytes from in and returns it as a uint32. The bool indicates whether the read was successful.

func ReadUint32

func ReadUint32(in *[]byte) (uint32, bool)

ReadUint32 removes the first bytes from in and returns it as an uint32. The bool indicates whether the read was successful.

func ReadUint8

func ReadUint8(in *[]byte) (uint8, bool)

ReadUint8 removes the first byte from in and returns it as an uint8. The bool indicates whether the read was successful.

func Skip

func Skip(in *[]byte, n int) bool

Skip removes the first n bytes from in. Returns whether it was successful.

func SkipReader

func SkipReader(in io.Reader, n int) error

ReadReaderSkip skips n bytes in in. At the end of the file, io.EOF is returned.

func WriteBytes

func WriteBytes(in *[]byte, bytes ...byte)

WriteBytes appends bytes at the end of in.

func WriteUint16

func WriteUint16(in *[]byte, v uint16)

WriteUint16 appends v at the end of in.

func WriteUint24

func WriteUint24(in *[]byte, v uint32)

WriteUint24 appends v at the end of in.

func WriteUint32

func WriteUint32(in *[]byte, v uint32)

WriteUint32 appends v at the end of in.

func WriteUint8

func WriteUint8(in *[]byte, v uint8)

WriteUint8 appends v at the end of in.

func WriteWriterBytes

func WriteWriterBytes(in io.Writer, bytes ...byte) error

WriteWriterBytes appends v at the end of in.

func WriteWriterUint16

func WriteWriterUint16(in io.Writer, v uint16) error

WriteWriterUint16 appends v at the end of in.

func WriteWriterUint24

func WriteWriterUint24(in io.Writer, v uint32) error

WriteWriterUint24 appends v at the end of in.

func WriteWriterUint32

func WriteWriterUint32(in io.Writer, v uint32) error

WriteWriterUint32 appends v at the end of in.

func WriteWriterUint8

func WriteWriterUint8(in io.Writer, v uint8) error

WriteWriterUint8 appends v at the end of in.

Types

type Buffer

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

func NewBuffer

func NewBuffer(bytes []byte) Buffer

func NewEmpty

func NewEmpty() Buffer

NewEmpty creates a Buffer with a zero length byte slice.

func ReadAll

func ReadAll(r io.Reader) (Buffer, error)

ReadAll reads from r until an error or EOF and returns a Buffer from the data it read. A successful call returns err == nil, not err == EOF. Because ReadAll is defined to read from src until EOF, it does not treat an EOF from Read as an error to be reported.

func (*Buffer) Bytes

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

Bytes returns the underlying byte slice.

func (*Buffer) BytesPointer

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

BytesPointer returns a pointer to the underlying byte slice.

func (*Buffer) Empty

func (b *Buffer) Empty() bool

Empty returns whether b is empty.

func (*Buffer) ReadBytes

func (b *Buffer) ReadBytes(n int) []byte

ReadBytes removes the first n bytes from b and returns it. If the read failed, returns nil.

func (*Buffer) ReadUint16

func (b *Buffer) ReadUint16() (uint16, bool)

ReadUint16 removes the first bytes from b and returns it as an uint16. The bool indicates whether the read was successful.

func (*Buffer) ReadUint24

func (b *Buffer) ReadUint24() (uint32, bool)

ReadUint24 removes the first bytes from b and returns it as a uint32. The bool indicates whether the read was successful.

func (*Buffer) ReadUint32

func (b *Buffer) ReadUint32() (uint32, bool)

ReadUint32 removes the first bytes from b and returns it as an uint32. The bool indicates whether the read was successful.

func (*Buffer) ReadUint8

func (b *Buffer) ReadUint8() (uint8, bool)

ReadUint8 removes the first byte from b and returns it as an uint8. The bool indicates whether the read was successful.

func (*Buffer) Size

func (b *Buffer) Size() int

Size returns the size of the underlying byte slice

func (*Buffer) Skip

func (b *Buffer) Skip(n int) bool

Skip removes the first n bytes from b. Returns whether it was successful.

func (*Buffer) WriteBytes

func (b *Buffer) WriteBytes(bytes ...byte)

WriteBytes appends bytes at the end of b.

func (*Buffer) WriteUint16

func (b *Buffer) WriteUint16(v uint16)

WriteUint16 appends v at the end of b.

func (*Buffer) WriteUint24

func (b *Buffer) WriteUint24(v uint32)

WriteUint24 appends v at the end of b.

func (*Buffer) WriteUint32

func (b *Buffer) WriteUint32(v uint32)

WriteUint32 appends v at the end of b.

func (*Buffer) WriteUint8

func (b *Buffer) WriteUint8(v uint8)

WriteUint8 appends v at the end of b.