buffer

Documentation

Index

• Variables
• type Ring
  • func NewRing[T any](initSize ...int) *Ring[T]
  • func (b *Ring[T]) Cap() int
  • func (b *Ring[T]) IsEmpty() bool
  • func (b *Ring[T]) Len() int
  • func (b *Ring[T]) Peek() (t T, err error)
  • func (b *Ring[T]) Read() (T, error)
  • func (b *Ring[T]) ReadAll() []T
  • func (b *Ring[T]) ReadMulti(n int) ([]T, error)
  • func (b *Ring[T]) Reset()
  • func (b *Ring[T]) Write(v T)
• type RingUnbounded
  • func NewRingUnbounded[T any](bufferSize int) *RingUnbounded[T]
  • func (b *RingUnbounded[T]) Close() <-chan struct{}
  • func (b *RingUnbounded[T]) Closed() bool
  • func (b *RingUnbounded[T]) Read() <-chan T
  • func (b *RingUnbounded[T]) Write(v T)
• type Unbounded
  • func NewUnbounded[V any]() *Unbounded[V]
  • func (slf *Unbounded[V]) Close()
  • func (slf *Unbounded[V]) Get() <-chan V
  • func (slf *Unbounded[V]) IsClosed() bool
  • func (slf *Unbounded[V]) Load()
  • func (slf *Unbounded[V]) Put(t V)

Variables

var (
	ErrBufferIsEmpty = errors.New("buffer is empty") // 缓冲区为空
)

Types

type Ring

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

Ring 环形缓冲区

func NewRing

func NewRing[T any](initSize ...int) *Ring[T]

NewRing 创建一个并发不安全的环形缓冲区

• initSize: 初始容量

当初始容量小于 2 或未设置时，将会使用默认容量 2

func (*Ring[T]) Cap

func (b *Ring[T]) Cap() int

Cap 返回缓冲区容量

func (*Ring[T]) IsEmpty

func (b *Ring[T]) IsEmpty() bool

IsEmpty 是否为空

func (*Ring[T]) Len

func (b *Ring[T]) Len() int

Len 返回缓冲区长度

func (*Ring[T]) Peek

func (b *Ring[T]) Peek() (t T, err error)

Peek 查看数据

func (*Ring[T]) Read

func (b *Ring[T]) Read() (T, error)

Read 读取数据

func (*Ring[T]) ReadAll

func (b *Ring[T]) ReadAll() []T

ReadAll 读取所有数据

func (*Ring[T]) ReadMulti

func (b *Ring[T]) ReadMulti(n int) ([]T, error)

ReadMulti 读取多个数据

func (*Ring[T]) Reset

func (b *Ring[T]) Reset()

Reset 重置缓冲区

func (*Ring[T]) Write

func (b *Ring[T]) Write(v T)

Write 写入数据

type RingUnbounded

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

RingUnbounded 基于环形缓冲区实现的无界缓冲区

func NewRingUnbounded

func NewRingUnbounded[T any](bufferSize int) *RingUnbounded[T]

NewRingUnbounded 创建一个并发安全的基于环形缓冲区实现的无界缓冲区

func (*RingUnbounded[T]) Close

func (b *RingUnbounded[T]) Close() <-chan struct{}

Close 关闭缓冲区，关闭后将不再接收新数据，但是已有数据仍然可以读取

func (*RingUnbounded[T]) Closed

func (b *RingUnbounded[T]) Closed() bool

Closed 判断缓冲区是否已关闭

func (*RingUnbounded[T]) Read

func (b *RingUnbounded[T]) Read() <-chan T

Read 读取数据

func (*RingUnbounded[T]) Write

func (b *RingUnbounded[T]) Write(v T)

Write 写入数据

type Unbounded

type Unbounded[V any] struct {
	// contains filtered or unexported fields
}

Unbounded 是无界缓冲区的实现

func NewUnbounded

func NewUnbounded[V any]() *Unbounded[V]

NewUnbounded 创建一个无界缓冲区

• generateNil: 生成空值的函数，该函数仅需始终返回 nil 即可

该缓冲区来源于 gRPC 的实现，用于在不使用额外 goroutine 的情况下实现无界缓冲区

• 该缓冲区的所有方法都是线程安全的，除了用于同步的互斥锁外，不会阻塞任何东西

func (*Unbounded[V]) Close

func (slf *Unbounded[V]) Close()

Close 关闭

func (*Unbounded[V]) Get

func (slf *Unbounded[V]) Get() <-chan V

Get 获取读取通道

func (*Unbounded[V]) IsClosed

func (slf *Unbounded[V]) IsClosed() bool

IsClosed 是否已关闭

func (*Unbounded[V]) Load

func (slf *Unbounded[V]) Load()

Load 将缓冲区中的数据发送到读取通道中，如果缓冲区中没有数据，则不会发送

• 在每次 Get 后都应该执行该函数

func (*Unbounded[V]) Put

func (slf *Unbounded[V]) Put(t V)

Put 将数据放入缓冲区