buffer

package
v0.5.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 12, 2024 License: MIT Imports: 2 Imported by: 0

README

Buffer

Go doc

该包提供了多种缓冲区实现,包括环形缓冲区和无界缓冲区。开发者可以使用它来快速构建和管理缓冲区。

Ring 环形缓冲区

环形缓冲区是一种特殊的缓冲区,它的头尾是相连的。当缓冲区满时,新的元素会覆盖旧的元素。环形缓冲区在 Minotaur 中是一个泛型类型,可以容纳任意类型的元素。

Unbounded 无界缓冲区

该缓冲区来源于 gRPC 的实现,用于在不使用额外 goroutine 的情况下实现无界缓冲区。无界缓冲区是一种特殊的缓冲区,它的大小可以动态扩展,不会出现溢出的情况。无界缓冲区在 Minotaur 中也是一个泛型类型,可以容纳任意类型的元素。

使用示例

环形缓冲区:

package main

import (
    "fmt"
    "github.com/kercylan98/minotaur/utils/buffer"
)

func main() {
    ring := buffer.NewRing[int](5)
    for i := 0; i < 5; i++ {
        ring.Write(i)
    }

    for i := 0; i < 5; i++ {
        v, _ := ring.Read()
        fmt.Println(v) // 0 1 2 3 4
    }
}

无界缓冲区:

package main

import (
    "fmt"
    "github.com/kercylan98/minotaur/utils/buffer"
)

func main() {
    unbounded := buffer.NewUnbounded[int]()
    for i := 0; i < 10; i++ {
        unbounded.Put(i)
    }

    for {
        select {
            case v, ok := <-unbounded.Get():
                if !ok {
                    return
                }
                unbounded.Load()
                fmt.Println(v) // 0 1 2 3 4 5 6 7 8 9
                if v == 9 {
                    unbounded.Close()
                    return
                }
        } 
    }
}

Documentation

Overview

Package buffer 提供了缓冲区相关的实用程序。

包括创建、读取和写入缓冲区的函数。

这个包还提供了一个无界缓冲区的实现,可以在不使用额外 goroutine 的情况下实现无界缓冲区。

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

Index

Constants

This section is empty.

Variables

View Source
var (
	ErrBufferIsEmpty = errors.New("buffer is empty")
)

Functions

This section 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 added in v0.5.0

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

ReadAll 读取所有数据

func (*Ring[T]) Reset

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

Reset 重置缓冲区

func (*Ring[T]) Write

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

Write 写入数据

type RingUnbounded added in v0.5.0

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

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

func NewRingUnbounded added in v0.5.0

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

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

func (*RingUnbounded[T]) Close added in v0.5.0

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

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

func (*RingUnbounded[T]) Closed added in v0.5.0

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

Closed 判断缓冲区是否已关闭

func (*RingUnbounded[T]) Read added in v0.5.0

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

Read 读取数据

func (*RingUnbounded[T]) Write added in v0.5.0

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 added in v0.2.1

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 将数据放入缓冲区

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL