以下常用方法列表,文档更新可能滞后于代码新特性,更多的方法及示例请参考代码文档:https://pkg.go.dev/github.com/gogf/gf/v2/container/gring

New

  • 说明:New创建并返回cap元素的环形结构。可选参数safe指定是否在并发安全中使用此结构,默认情况下为false

  • 格式:

    1. New(cap int, safe ...bool) *Ring
  • 示例:

    1. func ExampleNew() {
    2. // Non concurrent safety
    3. gring.New(10)
    4. // Concurrent safety
    5. gring.New(10, true)
    6. // Output:
    7. }

Val

  • 说明:Val返回当前位置的值。
  • 格式:

    1. Val() interface{}
  • 示例:

    1. func ExampleRing_Val() {
    2. r := gring.New(10)
    3. r.Set(1)
    4. fmt.Println("Val:", r.Val())
    5. r.Next().Set("GoFrame")
    6. fmt.Println("Val:", r.Val())
    7. // Output:
    8. // Val: 1
    9. // Val: GoFrame
    10. }

Len

  • 说明:Len返回Ring的大小。
  • 格式:

    1. Len() int
  • 示例:

    1. func ExampleRing_Len() {
    2. r1 := gring.New(10)
    3. for i := 0; i < 5; i++ {
    4. r1.Set(i).Next()
    5. }
    6. fmt.Println("Len:", r1.Len())
    7. r2 := gring.New(10, true)
    8. for i := 0; i < 10; i++ {
    9. r2.Set(i).Next()
    10. }
    11. fmt.Println("Len:", r2.Len())
    12. // Output:
    13. // Len: 5
    14. // Len: 10
    15. }

Cap

  • 说明:Cap返回Ring的容量。
  • 格式:

    1. Cap() int
  • 示例:

    1. func ExampleRing_Cap() {
    2. r1 := gring.New(10)
    3. for i := 0; i < 5; i++ {
    4. r1.Set(i).Next()
    5. }
    6. fmt.Println("Cap:", r1.Cap())
    7. r2 := gring.New(10, true)
    8. for i := 0; i < 10; i++ {
    9. r2.Set(i).Next()
    10. }
    11. fmt.Println("Cap:", r2.Cap())
    12. // Output:
    13. // Cap: 10
    14. // Cap: 10
    15. }

Set

  • 说明:Set将为当前位置的值设置为Value
  • 格式:

    1. Set(value interface{}) *Ring
  • 示例:

    1. func ExampleRing_Set() {
    2. r := gring.New(10)
    3. r.Set(1)
    4. fmt.Println("Val:", r.Val())
    5. r.Next().Set("GoFrame")
    6. fmt.Println("Val:", r.Val())
    7. // Output:
    8. // Val: 1
    9. // Val: GoFrame
    10. }

Put

  • 说明:Put将为当前位置的值设置为Value,并将ring移动到下一个位置。
  • 格式:

    1. Put(value interface{}) *Ring
  • 示例:

    1. func ExampleRing_Put() {
    2. r := gring.New(10)
    3. r.Put(1)
    4. fmt.Println("Val:", r.Val())
    5. fmt.Println("Val:", r.Prev().Val())
    6. // Output:
    7. // Val: <nil>
    8. // Val: 1
    9. }

Move

  • 说明:正向或者逆向移动n % r.Len()个节点,并返回移动后指向的位置。当n>=0时,为正向移动,反之为反向移动。
  • 格式:

    1. Move(n int) *Ring
  • 示例:

    1. func ExampleRing_Move() {
    2. r := gring.New(10)
    3. for i := 0; i < 10; i++ {
    4. r.Set(i).Next()
    5. }
    6. // ring at Pos 0
    7. fmt.Println("CurVal:", r.Val())
    8. r.Move(5)
    9. // ring at Pos 5
    10. fmt.Println("CurVal:", r.Val())
    11. // Output:
    12. // CurVal: 0
    13. // CurVal: 5
    14. }

Prev

  • 说明:Prev返回ring上一个位置的元素。
  • 格式:

    1. Prev() *Ring
  • 示例:

    1. func ExampleRing_Prev() {
    2. r := gring.New(10)
    3. for i := 0; i < 5; i++ {
    4. r.Set(i).Next()
    5. }
    6. fmt.Println("Prev:", r.Prev().Val())
    7. fmt.Println("Prev:", r.Prev().Val())
    8. // Output:
    9. // Prev: 4
    10. // Prev: 3
    11. }

Next

  • 说明:Next 返回ring下一个位置的元素。
  • 格式:

    1. Next() *Ring
  • 示例:

    1. func ExampleRing_Next() {
    2. r := gring.New(10)
    3. for i := 5; i > 0; i-- {
    4. r.Set(i).Prev()
    5. }
    6. fmt.Println("Prev:", r.Next().Val())
    7. fmt.Println("Prev:", r.Next().Val())
    8. // Output:
    9. // Prev: 1
    10. // Prev: 2
    11. }

Link

  • 说明:
  • 1. Linkring rring s连接起来,使r.Next()变为s并返回r.Next()的原始值。r不能为空。Link后,ring rLenCap会变为原始rsLenCap之和。
  • 2. 如果rs指向同一个ring,则连接它们将从ring中删除rs之间的元素。移除的元素形成一个子ring,结果是对该子ring的引用(如果没有移除任何元素,则结果仍然是r.Next()的原始值,而不是nil)。
  • 3. 如果rs指向不同的ring,则连接它们将创建一个ring,其中s的元素插入r之后。结果指向插入后s的最后一个元素后面的元素。
  • 格式:

    1. (r *Ring) Link(s *Ring) *Ring
  • 示例:

    1. func ExampleRing_Link_Common() {
    2. r := gring.New(10)
    3. for i := 0; i < 5; i++ {
    4. r.Set(i).Next()
    5. }
    6. s := gring.New(10)
    7. for i := 0; i < 10; i++ {
    8. val := i + 5
    9. s.Set(val).Next()
    10. }
    11. r.Link(s) // Link Ring s to Ring r
    12. fmt.Println("Len:", r.Len())
    13. fmt.Println("Cap:", r.Cap())
    14. fmt.Println(r.SlicePrev())
    15. fmt.Println(r.SliceNext())
    16. // Output:
    17. // Len: 15
    18. // Cap: 20
    19. // [4 3 2 1 0]
    20. // [5 6 7 8 9 10 11 12 13 14]
    21. }
    1. func ExampleRing_Link_SameRing() {
    2. r := gring.New(10)
    3. for i := 0; i < 5; i++ {
    4. r.Set(i).Next()
    5. }
    6. same_r := r.Link(r.Prev())
    7. fmt.Println("Len:", same_r.Len())
    8. fmt.Println("Cap:", same_r.Cap())
    9. fmt.Println(same_r.SlicePrev())
    10. fmt.Println(same_r.SliceNext())
    11. // Output:
    12. // Len: 1
    13. // Cap: 1
    14. // [4]
    15. // [4]
    16. }

Unlink

  • 说明:Unlinkr.next()开始,从ring中删除n % r.len()个元素。如果n % r.len() == 0,则ring保持不变。返回值为删除的subring
  • 格式:

    1. Set(value interface{}) *Ring
  • 示例:

    1. func ExampleRing_Unlink() {
    2. r := gring.New(10)
    3. for i := 0; i < 10; i++ {
    4. r.Set(i).Next()
    5. }
    6. fmt.Println("Before Unlink, Len:", r.Len())
    7. fmt.Println("Before Unlink, Cap:", r.Cap())
    8. fmt.Println("Before Unlink, ", r.SlicePrev())
    9. fmt.Println("Before Unlink, ", r.SliceNext())
    10. r.Unlink(7)
    11. fmt.Println("After Unlink, Len:", r.Len())
    12. fmt.Println("After Unlink, Cap:", r.Cap())
    13. fmt.Println("After Unlink, ", r.SlicePrev())
    14. fmt.Println("After Unlink, ", r.SliceNext())
    15. // Output:
    16. // Before Unlink, Len: 10
    17. // Before Unlink, Cap: 10
    18. // Before Unlink, [0 9 8 7 6 5 4 3 2 1]
    19. // Before Unlink, [0 1 2 3 4 5 6 7 8 9]
    20. // After Unlink, Len: 7
    21. // After Unlink, Cap: 7
    22. // After Unlink, [1 7 6 5 4 3 2]
    23. // After Unlink, [1 2 3 4 5 6 7]
    24. }

RLockIteratorNext

  • 说明:RLockIteratorNextRWMutex.RLock中迭代的回调给定的func f进行正向读取。如果fun f返回true,则继续迭代;如果返回false则停止。
  • 格式:

    1. RLockIteratorNext(f func(value interface{}) bool)
  • 示例:

    1. func ExampleRing_RLockIteratorNext() {
    2. r := gring.New(10)
    3. for i := 0; i < 10; i++ {
    4. r.Set(i).Next()
    5. }
    6. r.RLockIteratorNext(func(value interface{}) bool {
    7. if value.(int) < 5 {
    8. fmt.Println("IteratorNext Success, Value:", value)
    9. return true
    10. }
    11. return false
    12. })
    13. // Output:
    14. // IteratorNext Success, Value: 0
    15. // IteratorNext Success, Value: 1
    16. // IteratorNext Success, Value: 2
    17. // IteratorNext Success, Value: 3
    18. // IteratorNext Success, Value: 4
    19. }

RLockIteratorPrev

  • 说明:RLockIteratorPrevRWMutex.RLock中迭代的回调给定的func f进行反向读取。如果fun f返回true,则继续迭代;如果返回false则停止。
  • 格式:

    1. RLockIteratorPrev(f func(value interface{}) bool)
  • 示例:

    1. func ExampleRing_RLockIteratorPrev() {
    2. r := gring.New(10)
    3. for i := 0; i < 10; i++ {
    4. r.Set(i).Next()
    5. }
    6. // move r to pos 9
    7. r.Prev()
    8. r.RLockIteratorPrev(func(value interface{}) bool {
    9. if value.(int) >= 5 {
    10. fmt.Println("IteratorPrev Success, Value:", value)
    11. return true
    12. }
    13. return false
    14. })
    15. // Output:
    16. // IteratorPrev Success, Value: 9
    17. // IteratorPrev Success, Value: 8
    18. // IteratorPrev Success, Value: 7
    19. // IteratorPrev Success, Value: 6
    20. // IteratorPrev Success, Value: 5
    21. }

SliceNext

  • 说明:SliceNextslice的形式返回从当前位置向后所有元素的值的副本。
  • 格式:

    1. SliceNext() []interface{}
  • 示例:

    1. func ExampleRing_SliceNext() {
    2. r := gring.New(10)
    3. for i := 0; i < 10; i++ {
    4. r.Set(i).Next()
    5. }
    6. fmt.Println(r.SliceNext())
    7. // Output:
    8. // [0 1 2 3 4 5 6 7 8 9]
    9. }

SlicePrev

  • 说明:SlicePrevslice的形式返回从当前位置向前所有元素的值的副本。
  • 格式:

    1. SlicePrev() []interface{}
  • 示例:

    1. func ExampleRing_SlicePrev() {
    2. r := gring.New(10)
    3. for i := 0; i < 10; i++ {
    4. r.Set(i).Next()
    5. }
    6. fmt.Println(r.SlicePrev())
    7. // Output:
    8. // [0 9 8 7 6 5 4 3 2 1]
    9. }