README
¶
bytebuilder
Golang API to manipulate byte slices.
Documentation
¶
Index ¶
- func ReadBytes(b *[]byte, n int) []byte
- func ReadInt(b *[]byte, bitSize int) (int, bool)
- 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(b *[]byte) (uint16, bool)
- func ReadUint24(b *[]byte) (uint32, bool)
- func ReadUint32(b *[]byte) (uint32, bool)
- func ReadUint8(b *[]byte) (uint8, bool)
- func Skip(b *[]byte, n int) bool
- func SkipReader(in io.Reader, n int) error
- func WriteBytes(b *[]byte, bytes ...byte)
- func WriteInt(b *[]byte, v int, bitSize int)
- func WriteUint16(b *[]byte, v uint16)
- func WriteUint24(b *[]byte, v uint32)
- func WriteUint32(b *[]byte, v uint32)
- func WriteUint8(b *[]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 (b *Buffer) Bytes() []byte
- func (b *Buffer) BytesPointer() *[]byte
- func (b *Buffer) Empty() bool
- func (b *Buffer) ReadBytes(n int) []byte
- func (b *Buffer) ReadGMTUnixTime32() (time.Time, bool)
- func (b *Buffer) ReadInt(bitSize int) (int, bool)
- 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) ReadVector(bitSize int) ([]byte, bool)
- func (b *Buffer) Size() int
- func (b *Buffer) Skip(n int) bool
- func (b *Buffer) WriteBytes(bytes ...byte)
- func (b *Buffer) WriteGMTUnixTime32(time time.Time)
- func (b *Buffer) WriteInt(v int, bitSize int)
- func (b *Buffer) WriteRandom(n int)
- func (b *Buffer) WriteUint16(v uint16)
- func (b *Buffer) WriteUint24(v uint32)
- func (b *Buffer) WriteUint32(v uint32)
- func (b *Buffer) WriteUint8(v uint8)
- func (b *Buffer) WriteVector(v []byte, bitSize int)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ReadBytes ¶
ReadBytes removes the first n bytes from b and returns it. If the read failed, returns nil.
func ReadInt ¶ added in v0.4.0
ReadInt removes the first bytes (depends on bitSize) from b and returns it as an int.
func ReadReaderBytes ¶
ReadReaderBytes reads n byte from in. At the end of the file, io.EOF is returned.
func ReadReaderUint16 ¶
ReadReaderUint16 reads bytes from in and returns it as an uint16. At the end of the file io.EOF returned.
func ReadReaderUint24 ¶
ReadReaderUint24 reads bytes from in and returns it as an uint32. At the end of the file, io.EOF is returned.
func ReadReaderUint32 ¶
ReadReaderUint32 reads bytes from in and returns it as an uint32. At the end of the file io.EOF returned.
func ReadReaderUint8 ¶
ReadReaderUint8 reads a byte from in and returns is as an uint8. At the end of the file, io.EOF is returned.
func ReadUint16 ¶
ReadUint16 removes the first bytes from b and returns it as an uint16. The bool indicates whether the read was successful.
func ReadUint24 ¶
ReadUint24 removes the first bytes from b and returns it as a uint32. The bool indicates whether the read was successful.
func ReadUint32 ¶
ReadUint32 removes the first bytes from b and returns it as an uint32. The bool indicates whether the read was successful.
func ReadUint8 ¶
ReadUint8 removes the first byte from b and returns it as an uint8. The bool indicates whether the read was successful.
func Skip ¶
Skip removes the first n bytes from b. Returns whether it was successful.
func SkipReader ¶
ReadReaderSkip skips n bytes in in. At the end of the file, io.EOF is returned.
func WriteBytes ¶
WriteBytes appends bytes at the end of b.
func WriteInt ¶ added in v0.4.0
WriteInt append v at the end of b with size bitSize.
func WriteWriterBytes ¶
WriteWriterBytes appends v at the end of in.
func WriteWriterUint16 ¶
WriteWriterUint16 appends v at the end of in.
func WriteWriterUint24 ¶
WriteWriterUint24 appends v at the end of in.
func WriteWriterUint32 ¶
WriteWriterUint32 appends v at the end of in.
Types ¶
type Buffer ¶
type Buffer struct {
// contains filtered or unexported fields
}
func ReadAll ¶
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) BytesPointer ¶
BytesPointer returns a pointer to the underlying byte slice.
func (*Buffer) ReadBytes ¶
ReadBytes removes the first n bytes from b and returns it. If the read failed, returns nil.
func (*Buffer) ReadGMTUnixTime32 ¶
ReadGMTUnixTime32 removes the first bytes from b and returns it as an unix time. The bool indicates whether the read was successful.
func (*Buffer) ReadInt ¶ added in v0.4.0
ReadInt removes the first bytes (depends on bitSize) from b and returns it as an int.
func (*Buffer) ReadUint16 ¶
ReadUint16 removes the first bytes from b and returns it as an uint16. The bool indicates whether the read was successful.
func (*Buffer) ReadUint24 ¶
ReadUint24 removes the first bytes from b and returns it as a uint32. The bool indicates whether the read was successful.
func (*Buffer) ReadUint32 ¶
ReadUint32 removes the first bytes from b and returns it as an uint32. The bool indicates whether the read was successful.
func (*Buffer) ReadUint8 ¶
ReadUint8 removes the first byte from b and returns it as an uint8. The bool indicates whether the read was successful.
func (*Buffer) ReadVector ¶ added in v0.4.0
ReadVector reads the length of bytes then the bytes itself. The length type is depend on bitSize (eg.: uint8, uint16, uint24, uint32). Therefore, bitSize must be 8/16/24/32. If bitSize is an invalid number, this function panics.
func (*Buffer) Size ¶
Size returns the size of the underlying byte slice
func (*Buffer) Skip ¶
Skip removes the first n bytes from b. Returns whether it was successful.
func (*Buffer) WriteBytes ¶
WriteBytes appends bytes at the end of b.
func (*Buffer) WriteGMTUnixTime32 ¶
WriteGMTUnixTime32 appends time to b in 32 bit unix format.
func (*Buffer) WriteInt ¶ added in v0.4.0
WriteInt append v at the end of b with size bitSize.
func (*Buffer) WriteRandom ¶
WriteRandom appends n random bytes to b. If failed to read random, this function panics.
func (*Buffer) WriteUint16 ¶
WriteUint16 appends v at the end of b.
func (*Buffer) WriteUint24 ¶
WriteUint24 appends v at the end of b.
func (*Buffer) WriteUint32 ¶
WriteUint32 appends v at the end of b.
func (*Buffer) WriteUint8 ¶
WriteUint8 appends v at the end of b.
func (*Buffer) WriteVector ¶ added in v0.4.0
WriteVector appends the length of bytes then the bytes itself. The length type is depend on bitSize (eg.: uint8, uint16, uint24, uint32). Therefore, bitSize must be 8/16/24/32. If bitSize is an invalid number, this function panics.
Source Files