gxbytes

Documentation

Index

• Constants
• Variables
• func AcquireBytes(size int) *[]byte
• func GetBytes(size int) *[]byte
• func GetBytesBuffer() *bytes.Buffer
• func PutBytes(buf *[]byte)
• func PutBytesBuffer(buf *bytes.Buffer)
• func ReleaseBytes(bufp *[]byte)
• func SetDefaultBytesPool(bp *BytesPool)
• type Buffer
  • func NewBuffer(buf []byte) *Buffer
  • func NewBufferString(s string) *Buffer
  • func (b *Buffer) Bytes() []byte
  • func (b *Buffer) Cap() int
  • func (b *Buffer) Grow(n int)
  • func (b *Buffer) Len() int
  • func (b *Buffer) Next(n int) []byte
  • func (b *Buffer) Read(p []byte) (n int, err error)
  • func (b *Buffer) ReadByte() (byte, error)
  • func (b *Buffer) ReadBytes(delim byte) (line []byte, err error)
  • func (b *Buffer) ReadFrom(r io.Reader) (n int64, err error)
  • func (b *Buffer) ReadRune() (r rune, size int, err error)
  • func (b *Buffer) ReadString(delim byte) (line string, err error)
  • func (b *Buffer) Reset()
  • func (b *Buffer) String() string
  • func (b *Buffer) Truncate(n int)
  • func (b *Buffer) UnreadByte() error
  • func (b *Buffer) UnreadRune() error
  • func (b *Buffer) Write(p []byte) (n int, err error)
  • func (b *Buffer) WriteByte(c byte) error
  • func (b *Buffer) WriteNextBegin(n int) []byte
  • func (b *Buffer) WriteNextEnd(n int) (int, error)
  • func (b *Buffer) WriteRune(r rune) (n int, err error)
  • func (b *Buffer) WriteString(s string) (n int, err error)
  • func (b *Buffer) WriteTo(w io.Writer) (n int64, err error)
• type BytesPool
  • func NewBytesPool(slotSize []int) *BytesPool
  • func (bp *BytesPool) AcquireBytes(size int) *[]byte
  • func (bp *BytesPool) ReleaseBytes(bufp *[]byte)
• type New
• type ObjectPool
  • func NewObjectPool(n New) *ObjectPool
  • func (p *ObjectPool) Get() PoolObject
  • func (p *ObjectPool) Put(o PoolObject)
• type PoolObject
• type SlicePool
  • func NewSlicePool() *SlicePool
  • func (p *SlicePool) Get(size int) *[]byte
  • func (p *SlicePool) Put(bufp *[]byte)

Examples

• GetBytes

Constants

const MinRead = 512

MinRead is the minimum slice size passed to a Read call by Buffer.ReadFrom. As long as the Buffer has at least MinRead bytes beyond what is required to hold the contents of r, ReadFrom will not grow the underlying buffer.

Variables

var ErrTooLarge = errors.New("bytes.Buffer: too large")

ErrTooLarge is passed to panic if memory cannot be allocated to store data in a buffer.

Functions

func AcquireBytes

func AcquireBytes(size int) *[]byte

AcquireBytes called by defaultBytesPool

func GetBytes

func GetBytes(size int) *[]byte

GetBytes returns *[]byte from SlicePool Deprecated instead by AcquireBytes

Example

str := "hello, world"
// Obtain a buffer from the pool.
bufPtr := GetBytes(len(str))
defer PutBytes(bufPtr)
buf := *bufPtr
copy(buf, []byte(str))
if string(buf) != str {
	panic("wrong slice buffer content!!")
}

func GetBytesBuffer

func GetBytesBuffer() *bytes.Buffer

GetBytesBuffer returns bytes.Buffer from pool

func PutBytes

func PutBytes(buf *[]byte)

PutBytes Put *[]byte to SlicePool Deprecated instead by ReleaseBytes

func PutBytesBuffer

func PutBytesBuffer(buf *bytes.Buffer)

PutIoBuffer returns IoBuffer to pool

func ReleaseBytes

func ReleaseBytes(bufp *[]byte)

ReleaseBytes called by defaultBytesPool

func SetDefaultBytesPool

func SetDefaultBytesPool(bp *BytesPool)

SetDefaultBytesPool change default pool options

Types

type Buffer

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

A Buffer is a variable-sized buffer of bytes with Read and Write methods. The zero value for Buffer is an empty buffer ready to use.

func NewBuffer

func NewBuffer(buf []byte) *Buffer

NewBuffer creates and initializes a new Buffer using buf as its initial contents. The new Buffer takes ownership of buf, and the caller should not use buf after this call. NewBuffer is intended to prepare a Buffer to read existing data. It can also be used to set the initial size of the internal buffer for writing. To do that, buf should have the desired capacity but a length of zero.

In most cases, new(Buffer) (or just declaring a Buffer variable) is sufficient to initialize a Buffer.

func NewBufferString

func NewBufferString(s string) *Buffer

NewBufferString creates and initializes a new Buffer using string s as its initial contents. It is intended to prepare a buffer to read an existing string.

In most cases, new(Buffer) (or just declaring a Buffer variable) is sufficient to initialize a Buffer.

func (*Buffer) Bytes

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

Bytes returns a slice of length b.Len() holding the unread portion of the buffer. The slice is valid for use only until the next buffer modification (that is, only until the next call to a method like Read, Write, Reset, or Truncate). The slice aliases the buffer content at least until the next buffer modification, so immediate changes to the slice will affect the result of future reads.

func (*Buffer) Cap

func (b *Buffer) Cap() int

Cap returns the capacity of the buffer's underlying byte slice, that is, the total space allocated for the buffer's data.

func (*Buffer) Grow

func (b *Buffer) Grow(n int)

Grow grows the buffer's capacity, if necessary, to guarantee space for another n bytes. After Grow(n), at least n bytes can be written to the buffer without another allocation. If n is negative, Grow will panic. If the buffer can't grow it will panic with ErrTooLarge.

func (*Buffer) Len

func (b *Buffer) Len() int

Len returns the number of bytes of the unread portion of the buffer; b.Len() == len(b.Bytes()).

func (*Buffer) Next

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

Next returns a slice containing the next n bytes from the buffer, advancing the buffer as if the bytes had been returned by Read. If there are fewer than n bytes in the buffer, Next returns the entire buffer. The slice is only valid until the next call to a read or write method.

func (*Buffer) Read

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

Read reads the next len(p) bytes from the buffer or until the buffer is drained. The return value n is the number of bytes read. If the buffer has no data to return, err is io.EOF (unless len(p) is zero); otherwise it is nil.

func (*Buffer) ReadByte

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

ReadByte reads and returns the next byte from the buffer. If no byte is available, it returns error io.EOF.

func (*Buffer) ReadBytes

func (b *Buffer) ReadBytes(delim byte) (line []byte, err error)

ReadBytes reads until the first occurrence of delim in the input, returning a slice containing the data up to and including the delimiter. If ReadBytes encounters an error before finding a delimiter, it returns the data read before the error and the error itself (often io.EOF). ReadBytes returns err != nil if and only if the returned data does not end in delim.

func (*Buffer) ReadFrom

func (b *Buffer) ReadFrom(r io.Reader) (n int64, err error)

ReadFrom reads data from r until EOF and appends it to the buffer, growing the buffer as needed. The return value n is the number of bytes read. Any error except io.EOF encountered during the read is also returned. If the buffer becomes too large, ReadFrom will panic with ErrTooLarge.

func (*Buffer) ReadRune

func (b *Buffer) ReadRune() (r rune, size int, err error)

ReadRune reads and returns the next UTF-8-encoded Unicode code point from the buffer. If no bytes are available, the error returned is io.EOF. If the bytes are an erroneous UTF-8 encoding, it consumes one byte and returns U+FFFD, 1.

func (*Buffer) ReadString

func (b *Buffer) ReadString(delim byte) (line string, err error)

ReadString reads until the first occurrence of delim in the input, returning a string containing the data up to and including the delimiter. If ReadString encounters an error before finding a delimiter, it returns the data read before the error and the error itself (often io.EOF). ReadString returns err != nil if and only if the returned data does not end in delim.

func (*Buffer) Reset

func (b *Buffer) Reset()

Reset resets the buffer to be empty, but it retains the underlying storage for use by future writes. Reset is the same as Truncate(0).

func (*Buffer) String

func (b *Buffer) String() string

String returns the contents of the unread portion of the buffer as a string. If the Buffer is a nil pointer, it returns "<nil>".

To build strings more efficiently, see the strings.Builder type.

func (*Buffer) Truncate

func (b *Buffer) Truncate(n int)

Truncate discards all but the first n unread bytes from the buffer but continues to use the same allocated storage. It panics if n is negative or greater than the length of the buffer.

func (*Buffer) UnreadByte

func (b *Buffer) UnreadByte() error

UnreadByte unreads the last byte returned by the most recent successful read operation that read at least one byte. If a write has happened since the last read, if the last read returned an error, or if the read read zero bytes, UnreadByte returns an error.

func (*Buffer) UnreadRune

func (b *Buffer) UnreadRune() error

UnreadRune unreads the last rune returned by ReadRune. If the most recent read or write operation on the buffer was not a successful ReadRune, UnreadRune returns an error. (In this regard it is stricter than UnreadByte, which will unread the last byte from any read operation.)

func (*Buffer) Write

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

Write appends the contents of p to the buffer, growing the buffer as needed. The return value n is the length of p; err is always nil. If the buffer becomes too large, Write will panic with ErrTooLarge.

func (*Buffer) WriteByte

func (b *Buffer) WriteByte(c byte) error

WriteByte appends the byte c to the buffer, growing the buffer as needed. The returned error is always nil, but is included to match bufio.Writer's WriteByte. If the buffer becomes too large, WriteByte will panic with ErrTooLarge.

func (*Buffer) WriteNextBegin

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

WriteNextBegin grows the buffer as needed. The return slice's length is @n and its start position is next to @b.buf. It means that the return slice and @b.buf share the same array space.

func (*Buffer) WriteNextEnd

func (b *Buffer) WriteNextEnd(n int) (int, error)

WriteNextEnd just expands @b.buf length to len(b.buf) + n. It is invoked after b.WriteNextBegin.

func (*Buffer) WriteRune

func (b *Buffer) WriteRune(r rune) (n int, err error)

WriteRune appends the UTF-8 encoding of Unicode code point r to the buffer, returning its length and an error, which is always nil but is included to match bufio.Writer's WriteRune. The buffer is grown as needed; if it becomes too large, WriteRune will panic with ErrTooLarge.

func (*Buffer) WriteString

func (b *Buffer) WriteString(s string) (n int, err error)

WriteString appends the contents of s to the buffer, growing the buffer as needed. The return value n is the length of s; err is always nil. If the buffer becomes too large, WriteString will panic with ErrTooLarge.

func (*Buffer) WriteTo

func (b *Buffer) WriteTo(w io.Writer) (n int64, err error)

WriteTo writes data to w until the buffer is drained or an error occurs. The return value n is the number of bytes written; it always fits into an int, but it is int64 to match the io.WriterTo interface. Any error encountered during the write is also returned.

type BytesPool

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

BytesPool hold specific size []byte

func NewBytesPool

func NewBytesPool(slotSize []int) *BytesPool

NewBytesPool creates a memory pool.

func (*BytesPool) AcquireBytes

func (bp *BytesPool) AcquireBytes(size int) *[]byte

AcquireBytes get specific length []byte

func (*BytesPool) ReleaseBytes

func (bp *BytesPool) ReleaseBytes(bufp *[]byte)

ReleaseBytes ...

type New

type New func() PoolObject

type ObjectPool

type ObjectPool struct {
	New New
	// contains filtered or unexported fields
}

Pool is bytes.Buffer Pool

func NewObjectPool

func NewObjectPool(n New) *ObjectPool

func (*ObjectPool) Get

func (p *ObjectPool) Get() PoolObject

take returns *bytes.Buffer from Pool

func (*ObjectPool) Put

func (p *ObjectPool) Put(o PoolObject)

give returns *byes.Buffer to Pool

type PoolObject

type PoolObject interface {
	Reset()
}

Pool object

type SlicePool

type SlicePool struct {
	BytesPool
}

SlicePool is []byte pools Deprecated

func NewSlicePool

func NewSlicePool() *SlicePool

newSlicePool returns SlicePool Deprecated instead by NewBytesPool

func (*SlicePool) Get

func (p *SlicePool) Get(size int) *[]byte

Get returns *[]byte from SlicePool

func (*SlicePool) Put

func (p *SlicePool) Put(bufp *[]byte)

Put returns *[]byte to SlicePool