The highest tagged major version is
Documentation
¶
Index ¶
- Variables
- func Recycle(p []byte)
- type RingBuffer
- func (r *RingBuffer) Bytes() []byte
- func (r *RingBuffer) Capacity() int
- func (r *RingBuffer) Free() int
- func (r *RingBuffer) IsEmpty() bool
- func (r *RingBuffer) IsFull() bool
- func (r *RingBuffer) Length() int
- func (r *RingBuffer) PreRead(len int) (top []byte, tail []byte)
- func (r *RingBuffer) PreReadAll() (top []byte, tail []byte)
- func (r *RingBuffer) Read(p []byte) (n int, err error)
- func (r *RingBuffer) ReadByte() (b byte, err error)
- func (r *RingBuffer) Reset()
- func (r *RingBuffer) Shift(len int)
- func (r *RingBuffer) WithBytes(b []byte) []byte
- func (r *RingBuffer) Write(p []byte) (n int, err error)
- func (r *RingBuffer) WriteByte(c byte) error
- func (r *RingBuffer) WriteString(s string) (n int, err error)
Constants ¶
This section is empty.
Variables ¶
var ErrIsEmpty = errors.New("ring-buffer is empty")
ErrIsEmpty will be returned when trying to read a empty ring-buffer
Functions ¶
Types ¶
type RingBuffer ¶
type RingBuffer struct {
// contains filtered or unexported fields
}
RingBuffer is a circular buffer that implement io.ReaderWriter interface.
func New ¶
func New(size int) *RingBuffer
New returns a new RingBuffer whose buffer has the given size.
func (*RingBuffer) Bytes ¶
func (r *RingBuffer) Bytes() []byte
Bytes returns all available read bytes. It does not move the read pointer and only copy the available data.
func (*RingBuffer) Capacity ¶
func (r *RingBuffer) Capacity() int
Capacity returns the size of the underlying buffer.
func (*RingBuffer) Free ¶
func (r *RingBuffer) Free() int
Free returns the length of available bytes to write.
func (*RingBuffer) IsEmpty ¶
func (r *RingBuffer) IsEmpty() bool
IsEmpty returns this ringbuffer is empty.
func (*RingBuffer) IsFull ¶
func (r *RingBuffer) IsFull() bool
IsFull returns this ringbuffer is full.
func (*RingBuffer) Length ¶
func (r *RingBuffer) Length() int
Length return the length of available read bytes.
func (*RingBuffer) PreRead ¶
func (r *RingBuffer) PreRead(len int) (top []byte, tail []byte)
PreRead reads the bytes with given length but will not move the pointer of "read".
func (*RingBuffer) PreReadAll ¶
func (r *RingBuffer) PreReadAll() (top []byte, tail []byte)
PreReadAll reads the all bytes in this ring-buffer but will not move the pointer of "read".
func (*RingBuffer) Read ¶
func (r *RingBuffer) Read(p []byte) (n int, err error)
Read reads up to len(p) bytes into p. It returns the number of bytes read (0 <= n <= len(p)) and any error encountered. Even if Read returns n < len(p), it may use all of p as scratch space during the call. If some data is available but not len(p) bytes, Read conventionally returns what is available instead of waiting for more. When Read encounters an error or end-of-file condition after successfully reading n > 0 bytes, it returns the number of bytes read. It may return the (non-nil) error from the same call or return the error (and n == 0) from a subsequent call. Callers should always process the n > 0 bytes returned before considering the error err. Doing so correctly handles I/O errors that happen after reading some bytes and also both of the allowed EOF behaviors.
func (*RingBuffer) ReadByte ¶
func (r *RingBuffer) ReadByte() (b byte, err error)
ReadByte reads and returns the next byte from the input or ErrIsEmpty.
func (*RingBuffer) Reset ¶
func (r *RingBuffer) Reset()
Reset the read pointer and writer pointer to zero.
func (*RingBuffer) Shift ¶ added in v1.0.0
func (r *RingBuffer) Shift(len int)
Shift shifts the "read" pointer.
func (*RingBuffer) WithBytes ¶
func (r *RingBuffer) WithBytes(b []byte) []byte
WithBytes combines the available read bytes and the given bytes. It does not move the read pointer and only copy the available data.
func (*RingBuffer) Write ¶
func (r *RingBuffer) Write(p []byte) (n int, err error)
Write writes len(p) bytes from p to the underlying buf. It returns the number of bytes written from p (n == len(p) > 0) and any error encountered that caused the write to stop early. If the length of p is greater than the writable capacity of this ring-buffer, it will allocate more memory to this ring-buffer. Write must not modify the slice data, even temporarily.
func (*RingBuffer) WriteByte ¶
func (r *RingBuffer) WriteByte(c byte) error
WriteByte writes one byte into buffer
func (*RingBuffer) WriteString ¶
func (r *RingBuffer) WriteString(s string) (n int, err error)
WriteString writes the contents of the string s to buffer, which accepts a slice of bytes.
Source Files