doc: update for release v2.3.5

2026-02-04 12:52:28 +08:00 · 2025-03-07 14:19:07 +08:00
parent 8120c4db78
commit 6dfdadd34e
18 changed files with 147 additions and 128 deletions
--- a/docs/api/packages/datetime.md
+++ b/docs/api/packages/datetime.md
@@ -153,7 +153,7 @@ func main() {
 func AddWeek(t time.Time, weeks int64) time.Time
 ```

-<b>示例:<span style="float:right;display:inline-block;">[运行](todo)</span></b>
+<b>示例:<span style="float:right;display:inline-block;">[运行](https://go.dev/play/p/M9TqdMiaA2p)</span></b>

 ```go
 package main
@@ -189,7 +189,7 @@ func main() {
 func AddMonth(t time.Time, months int64) time.Time
 ```

-<b>示例:<span style="float:right;display:inline-block;">[运行](todo)</span></b>
+<b>示例:<span style="float:right;display:inline-block;">[运行](https://go.dev/play/p/DLoiOnpLvsN)</span></b>

 ```go
 package main
@@ -333,7 +333,7 @@ func main() {
 func AddDaySafe(t time.Time, days int) time.Time
 ```

-<b>示例:<span style="float:right;display:inline-block;">[运行](todo)</span></b>
+<b>示例:<span style="float:right;display:inline-block;">[运行](https://go.dev/play/p/JTohZFpoDJ3)</span></b>

 ```go
 package main
@@ -380,7 +380,7 @@ func main() {
 func AddMonthSafe(t time.Time, months int) time.Time
 ```

-<b>示例:<span style="float:right;display:inline-block;">[运行](todo)</span></b>
+<b>示例:<span style="float:right;display:inline-block;">[运行](https://go.dev/play/p/KLw0lo6mbVW)</span></b>

 ```go
 package main
@@ -417,7 +417,7 @@ func main() {
 func AddYearSafe(t time.Time, years int) time.Time
 ```

-<b>示例:<span style="float:right;display:inline-block;">[运行](todo)</span></b>
+<b>示例:<span style="float:right;display:inline-block;">[运行](https://go.dev/play/p/KVGXWZZ54ZH)</span></b>

 ```go
 package main
--- a/docs/api/packages/eventbus.md
+++ b/docs/api/packages/eventbus.md
@@ -48,7 +48,7 @@ import (
 func NewEventBus[T any]() *EventBus[T]
 ```

-<b>示例:<span style="float:right;display:inline-block;">[运行](todo)</span></b>
+<b>示例:<span style="float:right;display:inline-block;">[运行](https://go.dev/play/p/gHbOPV_NUOJ)</span></b>

 ```go
 import (
@@ -65,7 +65,7 @@ func main() {
    }

    eb.Subscribe("event1", listener, false, 0, nil)
-    eb.Publish(Event[int]{Topic: "event1", Payload: 1})
+    eb.Publish(eventbus.Event[int]{Topic: "event1", Payload: 1})

    fmt.Println(receivedData)

@@ -84,7 +84,7 @@ func main() {
 func (eb *EventBus[T]) Subscribe(topic string, listener func(eventData T), async bool, priority int, filter func(eventData T) bool)
 ```

-<b>示例:<span style="float:right;display:inline-block;">[运行](todo)</span></b>
+<b>示例:<span style="float:right;display:inline-block;">[运行](https://go.dev/play/p/EYGf_8cHei-)</span></b>

 ```go
 import (
@@ -106,8 +106,8 @@ func main() {

    eb.Subscribe("event1", listener, false, 0, filter)

-    eb.Publish(Event[int]{Topic: "event1", Payload: 1})
-    eb.Publish(Event[int]{Topic: "event1", Payload: 2})
+    eb.Publish(eventbus.Event[int]{Topic: "event1", Payload: 1})
+    eb.Publish(eventbus.Event[int]{Topic: "event1", Payload: 2})

    fmt.Println(receivedData)

@@ -126,7 +126,7 @@ func main() {
 func (eb *EventBus[T]) Unsubscribe(topic string, listener func(eventData T))
 ```

-<b>示例:<span style="float:right;display:inline-block;">[运行](todo)</span></b>
+<b>示例:<span style="float:right;display:inline-block;">[运行](https://go.dev/play/p/Tmh7Ttfvprf)</span></b>

 ```go
 import (
@@ -145,7 +145,7 @@ func main() {
    eb.Subscribe("event1", listener, false, 0, nil)
    eb.Unsubscribe("event1", listener)

-    eb.Publish(Event[int]{Topic: "event1", Payload: 1})
+    eb.Publish(eventbus.Event[int]{Topic: "event1", Payload: 1})

    fmt.Println(receivedData)

@@ -161,10 +161,10 @@ func main() {
 <b>函数签名:</b>

 ```go
-func (eb *EventBus[T]) Publish(event Event[T])
+func (eb *EventBus[T]) Publish(event eventbus.Event[T])
 ```

-<b>示例:<span style="float:right;display:inline-block;">[运行](todo)</span></b>
+<b>示例:<span style="float:right;display:inline-block;">[运行](https://go.dev/play/p/gHTtVexFSH9)</span></b>

 ```go
 import (
@@ -179,7 +179,7 @@ func main() {
        fmt.Println(eventData)
    }, false, 0, nil)

-    eb.Publish(Event[int]{Topic: "event1", Payload: 1})
+    eb.Publish(eventbus.Event[int]{Topic: "event1", Payload: 1})

    // Output:
    // 1
@@ -196,7 +196,7 @@ func main() {
 func (eb *EventBus[T]) ClearListeners()
 ```

-<b>示例:<span style="float:right;display:inline-block;">[运行](todo)</span></b>
+<b>示例:<span style="float:right;display:inline-block;">[运行](https://go.dev/play/p/KBfBYlKPgqD)</span></b>

 ```go
 import (
@@ -213,9 +213,12 @@ func main() {
    }

    eb.Subscribe("event1", listener, false, 0, nil)
+    eb.Subscribe("event2", listener, false, 0, nil)
+
    eb.ClearListeners()

-    eb.Publish(Event[int]{Topic: "event1", Payload: 1})
+    eb.Publish(eventbus.Event[int]{Topic: "event1", Payload: 1})
+    eb.Publish(eventbus.Event[int]{Topic: "event2", Payload: 2})

    fmt.Println(receivedData)

@@ -234,7 +237,7 @@ func main() {
 func (eb *EventBus[T]) ClearListenersByTopic(topic string)
 ```

-<b>示例:<span style="float:right;display:inline-block;">[运行](todo)</span></b>
+<b>示例:<span style="float:right;display:inline-block;">[运行](https://go.dev/play/p/gvMljmJOZmU)</span></b>

 ```go
 import (
@@ -251,14 +254,17 @@ func main() {
    }

    eb.Subscribe("event1", listener, false, 0, nil)
+    eb.Subscribe("event2", listener, false, 0, nil)
+    
    eb.ClearListenersByTopic("event1")

-    eb.Publish(Event[int]{Topic: "event1", Payload: 1})
+    eb.Publish(eventbus.Event[int]{Topic: "event1", Payload: 1})
+    eb.Publish(eventbus.Event[int]{Topic: "event2", Payload: 2})

    fmt.Println(receivedData)

    // Output:
-    // 0
+    // 2
 }
 ```

@@ -272,7 +278,7 @@ func main() {
 func (eb *EventBus[T]) GetListenersCount(topic string) int
 ```

-<b>示例:<span style="float:right;display:inline-block;">[运行](todo)</span></b>
+<b>示例:<span style="float:right;display:inline-block;">[运行](https://go.dev/play/p/j6yaJ2xAmFz)</span></b>

 ```go
 import (
@@ -284,14 +290,14 @@ func main() {
    eb := eventbus.NewEventBus[int]()

    eb.Subscribe("event1", func(eventData int) {}, false, 0, nil)
-    eb.Subscribe("event1", func(eventData int) {}, false, 0, nil)
+    eb.Subscribe("event2", func(eventData int) {}, false, 0, nil)

    count := eb.GetListenersCount("event1")

    fmt.Println(count)

    // Output:
-    // 2
+    // 1
 }
 ```

@@ -305,7 +311,7 @@ func main() {
 func (eb *EventBus[T]) GetAllListenersCount() int
 ```

-<b>示例:<span style="float:right;display:inline-block;">[运行](todo)</span></b>
+<b>示例:<span style="float:right;display:inline-block;">[运行](https://go.dev/play/p/PUlr0xcpEOz)</span></b>

 ```go
 import (
@@ -338,7 +344,7 @@ func main() {
 func (eb *EventBus[T]) GetEvents() []string
 ```

-<b>示例:<span style="float:right;display:inline-block;">[运行](todo)</span></b>
+<b>示例:<span style="float:right;display:inline-block;">[运行](https://go.dev/play/p/etgjjcOtAjX)</span></b>

 ```go
 import (
@@ -359,8 +365,8 @@ func main() {
    }

    // Output:
-    // event1
    // event2
+    // event1
 }
 ```

@@ -374,7 +380,7 @@ func main() {
 func (eb *EventBus[T]) SetErrorHandler(handler func(err error))
 ```

-<b>示例:<span style="float:right;display:inline-block;">[运行](todo)</span></b>
+<b>示例:<span style="float:right;display:inline-block;">[运行](https://go.dev/play/p/gmB0gnFe5mc)</span></b>

 ```go
 import (
@@ -393,7 +399,7 @@ func main() {
 		panic("error")
 	}, false, 0, nil)

-	eb.Publish(Event[int]{Topic: "event1", Payload: 1})
+	eb.Publish(eventbus.Event[int]{Topic: "event1", Payload: 1})

 	// Output:
 	// error
--- a/docs/api/packages/slice.md
+++ b/docs/api/packages/slice.md
@@ -887,7 +887,7 @@ func main() {
 func EqualUnordered[T comparable](slice1, slice2 []T) bool
 ```

-<b>示例:<span style="float:right;display:inline-block;">[运行](todo)</span></b>
+<b>示例:<span style="float:right;display:inline-block;">[运行](https://go.dev/play/p/n8fSc2w8ZgX)</span></b>

 ```go
 import (
@@ -1772,7 +1772,7 @@ func main() {
 func ReverseCopy[T any](slice []T) []T
 ```

-<b>示例:<span style="float:right;display:inline-block;">[运行](todo)</span></b>
+<b>示例:<span style="float:right;display:inline-block;">[运行](https://go.dev/play/p/c9arEaP7Cg-)</span></b>

 ```go
 import (
@@ -2065,7 +2065,7 @@ func main() {
 func ShuffleCopy[T any](slice []T) []T
 ```

-<b>示例:<span style="float:right;display:inline-block;">[运行](todo)</span></b>
+<b>示例:<span style="float:right;display:inline-block;">[运行](https://go.dev/play/p/vqDa-Gs1vT0)</span></b>

 ```go
 import (
--- a/docs/api/packages/strutil.md
+++ b/docs/api/packages/strutil.md
@@ -1772,7 +1772,7 @@ func main() {
 func FindAllOccurrences(str, substr string) []int
 ```

-<b>示例:<span style="float:right;display:inline-block;">[运行](todo)</span></b>
+<b>示例:<span style="float:right;display:inline-block;">[运行](https://go.dev/play/p/uvyA6azGLB1)</span></b>

 ```go
 import (
--- a/docs/api/packages/validator.md
+++ b/docs/api/packages/validator.md
@@ -1001,7 +1001,7 @@ func main() {
 func IsIpPort(str string) bool
 ```

-<b>示例:<span style="float:right;display:inline-block">[运行](todo)</span></b>
+<b>示例:<span style="float:right;display:inline-block">[运行](https://go.dev/play/p/xUmls_b9L29)</span></b>

 ```go
 import (
--- a/docs/en/api/packages/datetime.md
+++ b/docs/en/api/packages/datetime.md
@@ -155,7 +155,7 @@ func main() {
 func AddWeek(t time.Time, weeks int64) time.Time
 ```

-<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/M9TqdMiaA2p)</span></b>

 ```go
 package main
@@ -191,7 +191,7 @@ func main() {
 func AddMonth(t time.Time, months int64) time.Time
 ```

-<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/DLoiOnpLvsN)</span></b>

 ```go
 package main
@@ -335,7 +335,7 @@ func main() {
 func AddDaySafe(t time.Time, days int) time.Time
 ```

-<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/JTohZFpoDJ3)</span></b>

 ```go
 package main
@@ -382,7 +382,7 @@ func main() {
 func AddMonthSafe(t time.Time, months int) time.Time
 ```

-<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/KLw0lo6mbVW)</span></b>

 ```go
 package main
@@ -419,7 +419,7 @@ func main() {
 func AddYearSafe(t time.Time, years int) time.Time
 ```

-<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/KVGXWZZ54ZH)</span></b>

 ```go
 package main
--- a/docs/en/api/packages/eventbus.md
+++ b/docs/en/api/packages/eventbus.md
@@ -48,7 +48,7 @@ import (
 func NewEventBus[T any]() *EventBus[T]
 ```

-<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/gHbOPV_NUOJ)</span></b>

 ```go
 import (
@@ -65,7 +65,7 @@ func main() {
    }

    eb.Subscribe("event1", listener, false, 0, nil)
-    eb.Publish(Event[int]{Topic: "event1", Payload: 1})
+    eb.Publish(eventbus.Event[int]{Topic: "event1", Payload: 1})

    fmt.Println(receivedData)

@@ -84,7 +84,7 @@ func main() {
 func (eb *EventBus[T]) Subscribe(topic string, listener func(eventData T), async bool, priority int, filter func(eventData T) bool)
 ```

-<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/EYGf_8cHei-)</span></b>

 ```go
 import (
@@ -106,8 +106,8 @@ func main() {

    eb.Subscribe("event1", listener, false, 0, filter)

-    eb.Publish(Event[int]{Topic: "event1", Payload: 1})
-    eb.Publish(Event[int]{Topic: "event1", Payload: 2})
+    eb.Publish(eventbus.Event[int]{Topic: "event1", Payload: 1})
+    eb.Publish(eventbus.Event[int]{Topic: "event1", Payload: 2})

    fmt.Println(receivedData)

@@ -126,7 +126,7 @@ func main() {
 func (eb *EventBus[T]) Unsubscribe(topic string, listener func(eventData T))
 ```

-<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/Tmh7Ttfvprf)</span></b>

 ```go
 import (
@@ -145,7 +145,7 @@ func main() {
    eb.Subscribe("event1", listener, false, 0, nil)
    eb.Unsubscribe("event1", listener)

-    eb.Publish(Event[int]{Topic: "event1", Payload: 1})
+    eb.Publish(eventbus.Event[int]{Topic: "event1", Payload: 1})

    fmt.Println(receivedData)

@@ -161,10 +161,10 @@ func main() {
 <b>Signature:</b>

 ```go
-func (eb *EventBus[T]) Publish(event Event[T])
+func (eb *EventBus[T]) Publish(event eventbus.Event[T])
 ```

-<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/gHTtVexFSH9)</span></b>

 ```go
 import (
@@ -179,7 +179,7 @@ func main() {
        fmt.Println(eventData)
    }, false, 0, nil)

-    eb.Publish(Event[int]{Topic: "event1", Payload: 1})
+    eb.Publish(eventbus.Event[int]{Topic: "event1", Payload: 1})

    // Output:
    // 1
@@ -196,7 +196,7 @@ func main() {
 func (eb *EventBus[T]) ClearListeners()
 ```

-<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/KBfBYlKPgqD)</span></b>

 ```go
 import (
@@ -213,9 +213,12 @@ func main() {
    }

    eb.Subscribe("event1", listener, false, 0, nil)
+    eb.Subscribe("event2", listener, false, 0, nil)
+
    eb.ClearListeners()

-    eb.Publish(Event[int]{Topic: "event1", Payload: 1})
+    eb.Publish(eventbus.Event[int]{Topic: "event1", Payload: 1})
+    eb.Publish(eventbus.Event[int]{Topic: "event2", Payload: 2})

    fmt.Println(receivedData)

@@ -234,7 +237,7 @@ func main() {
 func (eb *EventBus[T]) ClearListenersByTopic(topic string)
 ```

-<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/gvMljmJOZmU)</span></b>

 ```go
 import (
@@ -251,14 +254,17 @@ func main() {
    }

    eb.Subscribe("event1", listener, false, 0, nil)
+    eb.Subscribe("event2", listener, false, 0, nil)
+    
    eb.ClearListenersByTopic("event1")

-    eb.Publish(Event[int]{Topic: "event1", Payload: 1})
+    eb.Publish(eventbus.Event[int]{Topic: "event1", Payload: 1})
+    eb.Publish(eventbus.Event[int]{Topic: "event2", Payload: 2})

    fmt.Println(receivedData)

    // Output:
-    // 0
+    // 2
 }
 ```

@@ -272,7 +278,7 @@ func main() {
 func (eb *EventBus[T]) GetListenersCount(topic string) int
 ```

-<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/j6yaJ2xAmFz)</span></b>

 ```go
 import (
@@ -284,14 +290,14 @@ func main() {
    eb := eventbus.NewEventBus[int]()

    eb.Subscribe("event1", func(eventData int) {}, false, 0, nil)
-    eb.Subscribe("event1", func(eventData int) {}, false, 0, nil)
+    eb.Subscribe("event2", func(eventData int) {}, false, 0, nil)

    count := eb.GetListenersCount("event1")

    fmt.Println(count)

    // Output:
-    // 2
+    // 1
 }
 ```

@@ -305,7 +311,7 @@ func main() {
 func (eb *EventBus[T]) GetAllListenersCount() int
 ```

-<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/PUlr0xcpEOz)</span></b>

 ```go
 import (
@@ -338,7 +344,7 @@ func main() {
 func (eb *EventBus[T]) GetEvents() []string
 ```

-<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/etgjjcOtAjX)</span></b>

 ```go
 import (
@@ -359,8 +365,8 @@ func main() {
    }

    // Output:
-    // event1
    // event2
+    // event1
 }
 ```

@@ -374,7 +380,7 @@ func main() {
 func (eb *EventBus[T]) SetErrorHandler(handler func(err error))
 ```

-<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/gmB0gnFe5mc)</span></b>

 ```go
 import (
@@ -393,7 +399,7 @@ func main() {
 		panic("error")
 	}, false, 0, nil)

-	eb.Publish(Event[int]{Topic: "event1", Payload: 1})
+	eb.Publish(eventbus.Event[int]{Topic: "event1", Payload: 1})

 	// Output:
 	// error
--- a/docs/en/api/packages/slice.md
+++ b/docs/en/api/packages/slice.md
@@ -852,7 +852,7 @@ func main() {
 func EqualUnordered[T comparable](slice1, slice2 []T) bool
 ```

-<b>Example:<span style="float:right;display:inline-block;">[运行](todo)</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[运行](https://go.dev/play/p/n8fSc2w8ZgX)</span></b>

 ```go
 import (
@@ -1768,7 +1768,7 @@ func main() {
 func ReverseCopy[T any](slice []T) []T
 ```

-<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/c9arEaP7Cg-)</span></b>

 ```go
 import (
@@ -2062,7 +2062,7 @@ func main() {
 func ShuffleCopy[T any](slice []T) []T
 ```

-<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/vqDa-Gs1vT0)</span></b>

 ```go
 import (
--- a/docs/en/api/packages/strutil.md
+++ b/docs/en/api/packages/strutil.md
@@ -1774,7 +1774,7 @@ func main() {
 func FindAllOccurrences(str, substr string) []int
 ```

-<b>Example:<span style="float:right;display:inline-block;">[Run](todo)</span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/uvyA6azGLB1)</span></b>

 ```go
 import (
--- a/docs/en/api/packages/validator.md
+++ b/docs/en/api/packages/validator.md
@@ -1003,7 +1003,7 @@ func main() {
 func IsIpPort(str string) bool
 ```

-<b>Example:<span style="float:right;display:inline-block">[Run](todo)</span></b>
+<b>Example:<span style="float:right;display:inline-block">[Run](https://go.dev/play/p/xUmls_b9L29)</span></b>

 ```go
 import (