protobytes

Documentation

Index

• type BytesReader
  • func (b *BytesReader) Cap() int
  • func (b *BytesReader) IsEmpty() bool
  • func (b *BytesReader) Len() int
  • func (b *BytesReader) Read(p []byte) (n int, err error)
  • func (b *BytesReader) ReadByte() (byte, error)
  • func (b *BytesReader) ReadIPv4() netip.Addr
  • func (b *BytesReader) ReadIPv6() netip.Addr
  • func (b *BytesReader) ReadUint16be() uint16
  • func (b *BytesReader) ReadUint16le() uint16
  • func (b *BytesReader) ReadUint32be() uint32
  • func (b *BytesReader) ReadUint32le() uint32
  • func (b *BytesReader) ReadUint64be() uint64
  • func (b *BytesReader) ReadUint64le() uint64
  • func (b *BytesReader) ReadUint8() uint8
  • func (b *BytesReader) ReadUvarint() (uint64, error)
  • func (b *BytesReader) ReadVarint() (int64, error)
  • func (b *BytesReader) Skip(n int)
  • func (b *BytesReader) SplitAt(n int) (BytesReader, BytesReader)
  • func (b *BytesReader) SplitBy(f func(byte) bool) (BytesReader, BytesReader)
• type BytesWriter
  • func (b *BytesWriter) Bytes() []byte
  • func (b *BytesWriter) Cap() int
  • func (b *BytesWriter) Grow(n int) int
  • func (b *BytesWriter) Len() int
  • func (b *BytesWriter) PutRune(r rune)
  • func (b *BytesWriter) PutSlice(p []byte)
  • func (b *BytesWriter) PutString(s string)
  • func (b *BytesWriter) PutUint16be(v uint16)
  • func (b *BytesWriter) PutUint16le(v uint16)
  • func (b *BytesWriter) PutUint32be(v uint32)
  • func (b *BytesWriter) PutUint32le(v uint32)
  • func (b *BytesWriter) PutUint64be(v uint64)
  • func (b *BytesWriter) PutUint64le(v uint64)
  • func (b *BytesWriter) PutUint8(v uint8)
  • func (b *BytesWriter) PutUvarint(v uint64)
  • func (b *BytesWriter) PutVarint(v int64)
  • func (b *BytesWriter) ReadFull(reader io.Reader, n int) error
  • func (b *BytesWriter) Reset()
  • func (b *BytesWriter) Slice(start, end int) BytesWriter
  • func (b *BytesWriter) Write(p []byte) (n int, err error)
• type Reader
  • func New(reader io.Reader) *Reader
  • func (p *Reader) Buffered() int
  • func (p *Reader) Error() error
  • func (p *Reader) Next(n int) (BytesReader, error)
  • func (p *Reader) Read(buf []byte) (n int, err error)
  • func (p *Reader) ReadFull(buf []byte) (err error)
  • func (p *Reader) Reset(reader io.Reader)
  • func (p *Reader) TryByte() (b byte)
  • func (p *Reader) TryNext(n int) BytesReader
  • func (p *Reader) TryPeekUint16be() (i uint16)
  • func (p *Reader) TryPeekUint16le() (i uint16)
  • func (p *Reader) TryPeekUint32be() (i uint32)
  • func (p *Reader) TryPeekUint32le() (i uint32)
  • func (p *Reader) TryPeekUint64be() (i uint64)
  • func (p *Reader) TryPeekUint64le() (i uint64)
  • func (p *Reader) TryPeekUint8() (i uint8)
  • func (p *Reader) TryReadFull(buf []byte)
  • func (p *Reader) TryReadUint16be() (i uint16)
  • func (p *Reader) TryReadUint16le() (i uint16)
  • func (p *Reader) TryReadUint32be() (i uint32)
  • func (p *Reader) TryReadUint32le() (i uint32)
  • func (p *Reader) TryReadUint64be() (i uint64)
  • func (p *Reader) TryReadUint64le() (i uint64)
  • func (p *Reader) TryReadUint8() (i uint8)

Types

type BytesReader

type BytesReader []byte

BytesReader is a wrapper for a byte slice that provides helper methods for reading various types of data from the slice.

func (*BytesReader) Cap

func (b *BytesReader) Cap() int

Cap returns the capacity of the byte slice.

func (*BytesReader) IsEmpty

func (b *BytesReader) IsEmpty() bool

IsEmpty checks if the byte slice is empty.

func (*BytesReader) Len

func (b *BytesReader) Len() int

Len returns the length of the byte slice.

func (*BytesReader) Read

func (b *BytesReader) Read(p []byte) (n int, err error)

Read reads up to len(p) bytes from the byte slice and skips len(p) bytes. implements io.Reader. If the buffer has no data to return, err is io.EOF (unless len(p) is zero); otherwise it is nil.

func (*BytesReader) ReadByte

func (b *BytesReader) ReadByte() (byte, error)

ReadByte implements io.ByteReader.

func (*BytesReader) ReadIPv4

func (b *BytesReader) ReadIPv4() netip.Addr

ReadIPv4 reads a net.IPAddr with an IPv4 address.

func (*BytesReader) ReadIPv6

func (b *BytesReader) ReadIPv6() netip.Addr

ReadIPv6 reads a net.IPAddr with an IPv6 address.

func (*BytesReader) ReadUint16be

func (b *BytesReader) ReadUint16be() uint16

ReadUint16be reads a uint16 value in big endian from the byte slice and skips 2 bytes.

func (*BytesReader) ReadUint16le

func (b *BytesReader) ReadUint16le() uint16

ReadUint16le reads a uint16 value in little endian from the byte slice and skips 2 bytes.

func (*BytesReader) ReadUint32be

func (b *BytesReader) ReadUint32be() uint32

ReadUint32be reads a uint32 value in big endian from the byte slice and skips 4 bytes.

func (*BytesReader) ReadUint32le

func (b *BytesReader) ReadUint32le() uint32

ReadUint32le reads a uint32 value in little endian from the byte slice and skips 4 bytes.

func (*BytesReader) ReadUint64be

func (b *BytesReader) ReadUint64be() uint64

ReadUint64be reads a uint64 value in big endian from the byte slice and skips 8 bytes.

func (*BytesReader) ReadUint64le

func (b *BytesReader) ReadUint64le() uint64

ReadUint64le reads a uint64 value in little endian from the byte slice and skips 8 bytes.

func (*BytesReader) ReadUint8

func (b *BytesReader) ReadUint8() uint8

ReadUint8 reads a uint8 value from the byte slice and skips 1 byte.

func (*BytesReader) ReadUvarint

func (b *BytesReader) ReadUvarint() (uint64, error)

ReadUvarint read Uvarint from the byte slice. it return error because of the length of the byte slice can't be sure.

func (*BytesReader) ReadVarint

func (b *BytesReader) ReadVarint() (int64, error)

ReadVarint read Varint from the byte slice. it return error because of the length of the byte slice can't be sure.

func (*BytesReader) Skip

func (b *BytesReader) Skip(n int)

Skip skips the given number of bytes.

func (*BytesReader) SplitAt

func (b *BytesReader) SplitAt(n int) (BytesReader, BytesReader)

SplitAt splits the byte slice at the given index and returns two new BytesReader.

func (*BytesReader) SplitBy

func (b *BytesReader) SplitBy(f func(byte) bool) (BytesReader, BytesReader)

SplitBy splits the byte slice by a given function and returns two new BytesReader.

type BytesWriter

type BytesWriter []byte

func (*BytesWriter) Bytes

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

func (*BytesWriter) Cap

func (b *BytesWriter) Cap() int

Cap returns the capacity of the byte slice.

func (*BytesWriter) Grow

func (b *BytesWriter) Grow(n int) int

Grow grows the buffer's capacity. It returns the index where bytes should be written.

func (*BytesWriter) Len

func (b *BytesWriter) Len() int

func (*BytesWriter) PutRune

func (b *BytesWriter) PutRune(r rune)

func (*BytesWriter) PutSlice

func (b *BytesWriter) PutSlice(p []byte)

func (*BytesWriter) PutString

func (b *BytesWriter) PutString(s string)

func (*BytesWriter) PutUint16be

func (b *BytesWriter) PutUint16be(v uint16)

func (*BytesWriter) PutUint16le

func (b *BytesWriter) PutUint16le(v uint16)

func (*BytesWriter) PutUint32be

func (b *BytesWriter) PutUint32be(v uint32)

func (*BytesWriter) PutUint32le

func (b *BytesWriter) PutUint32le(v uint32)

func (*BytesWriter) PutUint64be

func (b *BytesWriter) PutUint64be(v uint64)

func (*BytesWriter) PutUint64le

func (b *BytesWriter) PutUint64le(v uint64)

func (*BytesWriter) PutUint8

func (b *BytesWriter) PutUint8(v uint8)

func (*BytesWriter) PutUvarint

func (b *BytesWriter) PutUvarint(v uint64)

func (*BytesWriter) PutVarint

func (b *BytesWriter) PutVarint(v int64)

func (*BytesWriter) ReadFull

func (b *BytesWriter) ReadFull(reader io.Reader, n int) error

func (*BytesWriter) Reset

func (b *BytesWriter) Reset()

func (*BytesWriter) Slice

func (b *BytesWriter) Slice(start, end int) BytesWriter

func (*BytesWriter) Write

func (b *BytesWriter) Write(p []byte) (n int, err error)

type Reader

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

func New

func New(reader io.Reader) *Reader

func (*Reader) Buffered

func (p *Reader) Buffered() int

func (*Reader) Error

func (p *Reader) Error() error

func (*Reader) Next

func (p *Reader) Next(n int) (BytesReader, error)

func (*Reader) Read

func (p *Reader) Read(buf []byte) (n int, err error)

func (*Reader) ReadFull

func (p *Reader) ReadFull(buf []byte) (err error)

func (*Reader) Reset

func (p *Reader) Reset(reader io.Reader)

func (*Reader) TryByte

func (p *Reader) TryByte() (b byte)

func (*Reader) TryNext

func (p *Reader) TryNext(n int) BytesReader

func (*Reader) TryPeekUint16be

func (p *Reader) TryPeekUint16be() (i uint16)

func (*Reader) TryPeekUint16le

func (p *Reader) TryPeekUint16le() (i uint16)

func (*Reader) TryPeekUint32be

func (p *Reader) TryPeekUint32be() (i uint32)

func (*Reader) TryPeekUint32le

func (p *Reader) TryPeekUint32le() (i uint32)

func (*Reader) TryPeekUint64be

func (p *Reader) TryPeekUint64be() (i uint64)

func (*Reader) TryPeekUint64le

func (p *Reader) TryPeekUint64le() (i uint64)

func (*Reader) TryPeekUint8

func (p *Reader) TryPeekUint8() (i uint8)

func (*Reader) TryReadFull

func (p *Reader) TryReadFull(buf []byte)

func (*Reader) TryReadUint16be

func (p *Reader) TryReadUint16be() (i uint16)

func (*Reader) TryReadUint16le

func (p *Reader) TryReadUint16le() (i uint16)

func (*Reader) TryReadUint32be

func (p *Reader) TryReadUint32be() (i uint32)

func (*Reader) TryReadUint32le

func (p *Reader) TryReadUint32le() (i uint32)

func (*Reader) TryReadUint64be

func (p *Reader) TryReadUint64be() (i uint64)

func (*Reader) TryReadUint64le

func (p *Reader) TryReadUint64le() (i uint64)

func (*Reader) TryReadUint8

func (p *Reader) TryReadUint8() (i uint8)