ringparam

Documentation

Index

• type Ring
  • func New[T any](n int) Ring[T]
  • func (r Ring[T]) Clear()
  • func (r Ring[T]) Do(f func(v T, hasValue bool))
  • func (r Ring[T]) Get() (v T, ok bool)
  • func (r Ring[T]) Len() int
  • func (r Ring[T]) Link(s Ring[T]) Ring[T]
  • func (r Ring[T]) Move(n int) Ring[T]
  • func (r Ring[T]) Next() Ring[T]
  • func (r Ring[T]) Prev() Ring[T]
  • func (r Ring[T]) Set(v T)
  • func (r Ring[T]) Unlink(n int) Ring[T]
  • func (r Ring[T]) Unwrap() *ring.Ring

Types

type Ring

type Ring[T any] struct {
	// contains filtered or unexported fields
}

func New

func New[T any](n int) Ring[T]

func (Ring[T]) Clear

func (r Ring[T]) Clear()

Clear is equivalent to `ring.Value = nil`

func (Ring[T]) Do

func (r Ring[T]) Do(f func(v T, hasValue bool))

Do is equivalent of `container/ring`.Do but added hasValue boolean. hasValue is false if internal Value is nil, indicating passed value is zero of T. hasValue is true othrewize.

func (Ring[T]) Get

func (r Ring[T]) Get() (v T, ok bool)

Get returns internal Value. If internal Value is non-nil and then returns value and true. Otherwise returns zero of T and false.

func (Ring[T]) Len

func (r Ring[T]) Len() int

func (Ring[T]) Link

func (r Ring[T]) Link(s Ring[T]) Ring[T]

func (Ring[T]) Move

func (r Ring[T]) Move(n int) Ring[T]

func (Ring[T]) Next

func (r Ring[T]) Next() Ring[T]

func (Ring[T]) Prev

func (r Ring[T]) Prev() Ring[T]

func (Ring[T]) Set

func (r Ring[T]) Set(v T)

Set is equivalent to `ring.Value = v`

func (Ring[T]) Unlink

func (r Ring[T]) Unlink(n int) Ring[T]

func (Ring[T]) Unwrap

func (r Ring[T]) Unwrap() *ring.Ring

Unwrap returns internal *`container/rinng`.Ring. Setting non-T value may cause runtime panic in succeeding Get or Do call.