README
¶
ring
-- import "github.com/zealws/golang-ring"
Package ring provides a simple implementation of a ring buffer.
Usage
var DefaultCapacity int = 10
The DefaultCapacity of an uninitialized Ring buffer.
Changing this value only affects ring buffers created after it is changed.
type Ring
type Ring struct {
sync.Mutex
}
Type Ring implements a Circular Buffer. The default value of the Ring struct is a valid (empty) Ring buffer with capacity DefaultCapacify.
func (*Ring) Capacity
func (r *Ring) Capacity() int
Capacity returns the current capacity of the ring buffer.
func (*Ring) ContentSize
func (r *Ring) ContentSize() int
ContentSize returns the current number of elements inside the ring buffer.
func (*Ring) Dequeue
func (r *Ring) Dequeue() interface{}
Dequeue a value from the Ring buffer.
Returns nil if the ring buffer is empty.
func (*Ring) Enqueue
func (r *Ring) Enqueue(i interface{})
Enqueue a value into the Ring buffer.
func (*Ring) Peek
func (r *Ring) Peek() interface{}
Read the value that Dequeue would have dequeued without actually dequeuing it.
Returns nil if the ring buffer is empty.
func (*Ring) SetCapacity
func (r *Ring) SetCapacity(size int)
Set the maximum size of the ring buffer.
func (*Ring) Values
func (r *Ring) Values() []interface{}
Values returns a slice of all the values in the circular buffer without modifying them at all. The returned slice can be modified independently of the circular buffer. However, the values inside the slice are shared between the slice and circular buffer.
Documentation
¶
Overview ¶
Package ring provides a simple implementation of a ring buffer.
Index ¶
Constants ¶
This section is empty.
Variables ¶
var DefaultCapacity int = 10
The DefaultCapacity of an uninitialized Ring buffer.
Changing this value only affects ring buffers created after it is changed.
Functions ¶
This section is empty.
Types ¶
type Ring ¶
Type Ring implements a Circular Buffer. The default value of the Ring struct is a valid (empty) Ring buffer with capacity DefaultCapacify.
func (*Ring) ContentSize ¶
ContentSize returns the current number of elements inside the ring buffer.
func (*Ring) Dequeue ¶
func (r *Ring) Dequeue() interface{}
Dequeue a value from the Ring buffer.
Returns nil if the ring buffer is empty.
func (*Ring) Peek ¶
func (r *Ring) Peek() interface{}
Read the value that Dequeue would have dequeued without actually dequeuing it.
Returns nil if the ring buffer is empty.
func (*Ring) SetCapacity ¶
Set the maximum size of the ring buffer.
func (*Ring) Values ¶
func (r *Ring) Values() []interface{}
Values returns a slice of all the values in the circular buffer without modifying them at all. The returned slice can be modified independently of the circular buffer. However, the values inside the slice are shared between the slice and circular buffer.
Source Files