diff options
Diffstat (limited to 'vendor/github.com/zfjagann/golang-ring/README.md')
| -rw-r--r-- | vendor/github.com/zfjagann/golang-ring/README.md | 17 |
1 files changed, 11 insertions, 6 deletions
diff --git a/vendor/github.com/zfjagann/golang-ring/README.md b/vendor/github.com/zfjagann/golang-ring/README.md index 1da6cf73..56988e1b 100644 --- a/vendor/github.com/zfjagann/golang-ring/README.md +++ b/vendor/github.com/zfjagann/golang-ring/README.md @@ -1,9 +1,6 @@ # ring - -[](https://godoc.org/github.com/zfjagann/golang-ring) - -- - import "github.com/zfjagann/golang-ring" + import "github.com/zealws/golang-ring" Package ring provides a simple implementation of a ring buffer. @@ -20,19 +17,27 @@ Changing this value only affects ring buffers created after it is changed. ```go 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 (*Ring) Capacity ```go -func (r Ring) Capacity() int +func (r *Ring) Capacity() int ``` Capacity returns the current capacity of the ring buffer. +#### func (*Ring) ContentSize + +```go +func (r *Ring) ContentSize() int +``` +ContentSize returns the current number of elements inside the ring buffer. + #### func (*Ring) Dequeue ```go |