Merge pull request #695 from devlights:add-generic-ring

Add Generic *ring.Ring[T] example

Author: devlights

examples/basic/containers/examples.go

@@ -14,4 +14,5 @@ func NewRegister() mapping.Register {
 // Regist -- 登録します.
 func (r *register) Regist(m mapping.ExampleMapping) {
 	m["containers_ring"] = RingBuffer
+	m["containers_generic_ring"] = GenericRing
 }

examples/basic/containers/generic/ring/ring.go

@@ -0,0 +1,83 @@
+// Package ring は、container/ring/Ring をジェネリックにしたものが配置されています。
+package ring
+
+import "container/ring"
+
+// Ring[T] は、container/ring/Ring のジェネリック版です.
+//
+// 標準の *ring.Ring と異なり、値の設定は SetValue() で行います。
+type Ring[T any] struct {
+	r *ring.Ring // 実際の *ring.Ring
+	v T          // 値
+}
+
+// New は、新しい *Ring[T] を指定した容量で作成します。
+func New[T any](n int) *Ring[T] {
+	var v T
+	return &Ring[T]{ring.New(n), v}
+}
+
+// SetValue は、値を設定します。
+func (me *Ring[T]) SetValue(v T) {
+	me.v = v
+	me.r.Value = v
+}
+
+// Do は、標準ライブラリの container/ring/Ring.Do と同じ動きをします。
+//
+// # REFERENCES
+//   - https://pkg.go.dev/container/ring@go1.21.4#Ring.Do
+func (me *Ring[T]) Do(f func(T)) {
+	fn := func(v any) {
+		f(v.(T))
+	}
+	me.r.Do(fn)
+}
+
+// Len は、標準ライブラリの container/ring/Ring.Len と同じ動きをします。
+//
+// # REFERENCES
+//   - https://pkg.go.dev/container/ring@go1.21.4#Ring.Len
+func (me *Ring[T]) Len() int {
+	return me.r.Len()
+}
+
+// Link は、標準ライブラリの container/ring/Ring.Link と同じ動きをします。
+//
+// # REFERENCES
+//   - https://pkg.go.dev/container/ring@go1.21.4#Ring.Link
+func (me *Ring[T]) Link(s *Ring[T]) *Ring[T] {
+	return &Ring[T]{me.r.Link(s.r), me.v}
+}
+
+// Move は、標準ライブラリの container/ring/Ring.Move と同じ動きをします。
+//
+// # REFERENCES
+//   - https://pkg.go.dev/container/ring@go1.21.4#Ring.Move
+func (me *Ring[T]) Move(n int) *Ring[T] {
+	return &Ring[T]{me.r.Move(n), me.v}
+}
+
+// Next は、標準ライブラリの container/ring/Ring.Next と同じ動きをします。
+//
+// # REFERENCES
+//   - https://pkg.go.dev/container/ring@go1.21.4#Ring.Next
+func (me *Ring[T]) Next() *Ring[T] {
+	return &Ring[T]{me.r.Next(), me.v}
+}
+
+// Prev は、標準ライブラリの container/ring/Ring.Prev と同じ動きをします。
+//
+// # REFERENCES
+//   - https://pkg.go.dev/container/ring@go1.21.4#Ring.Prev
+func (me *Ring[T]) Prev() *Ring[T] {
+	return &Ring[T]{me.r.Prev(), me.v}
+}
+
+// Unlink は、標準ライブラリの container/ring/Ring.Unlink と同じ動きをします。
+//
+// # REFERENCES
+//   - https://pkg.go.dev/container/ring@go1.21.4#Ring.Unlink
+func (me *Ring[T]) Unlink(n int) *Ring[T] {
+	return &Ring[T]{me.r.Unlink(n), me.v}
+}

examples/basic/containers/genericring.go

@@ -0,0 +1,83 @@
+package containers
+
+import (
+	"fmt"
+
+	"github.com/devlights/try-golang/examples/basic/containers/generic/ring"
+
+	"github.com/devlights/gomy/output"
+)
+
+// GenericRing は、container/ring/Ring をジェネリックにしたもののサンプルです.
+//
+// # REFERENCES
+//   - https://pkg.go.dev/container/ring@go1.21.4
+func GenericRing() error {
+	var (
+		r = ring.New[string](5)
+		n = r.Len()
+	)
+
+	// 値を設定（１）
+	for i := 0; i < n; i++ {
+		r.SetValue(fmt.Sprintf("helloworld-%d", i))
+		r = r.Next()
+	}
+
+	// 現在のリングを出力
+	r.Do(func(v string) {
+		output.Stdoutl("[v]", v)
+	})
+	output.StdoutHr()
+
+	// 再度値を設定（２）
+	for i := 0; i < n; i++ {
+		r.SetValue(fmt.Sprintf("helloworld-%d", i+100))
+		r = r.Next()
+	}
+
+	// 現在のリングを出力
+	r.Do(func(v string) {
+		output.Stdoutl("[v]", v)
+	})
+	output.StdoutHr()
+
+	// 飛び飛びで設定（３）
+	r.SetValue("helloworld-997")
+	r = r.Next()
+	r = r.Next()
+	r.SetValue("helloworld-998")
+	r = r.Next()
+	r.SetValue("helloworld-999")
+
+	// 現在のリングを出力
+	r.Do(func(v string) {
+		output.Stdoutl("[v]", v)
+	})
+
+	return nil
+
+	/*
+	   $ task
+	   task: [build] go build .
+	   task: [run] ./try-golang -onetime
+
+	   ENTER EXAMPLE NAME: containers_generic_ring
+
+	   [Name] "containers_generic_ring"
+	   [v]                  helloworld-0
+	   [v]                  helloworld-1
+	   [v]                  helloworld-2
+	   [v]                  helloworld-3
+	   [v]                  helloworld-4
+	   [v]                  helloworld-999
+	   [v]                  helloworld-104
+	   [v]                  helloworld-998
+	   [v]                  helloworld-101
+	   [v]                  helloworld-102
+
+
+	   [Elapsed] 156.91µs
+	*/
+
+}