doc: add enum and update overview index

doc: add docment for enum package
2026-03-01 00:35:28 +08:00 · 2025-10-31 14:57:54 +08:00 · 2025-10-31 14:48:32 +08:00 · 2025-10-31 14:48:22 +08:00 · 2025-10-31 13:37:41 +08:00
21 changed files with 2524 additions and 354 deletions
--- a/README.md
+++ b/README.md
@@ -1125,6 +1125,10 @@ import "github.com/duke-git/lancet/v2/maputil"
 -   **<big>FindValuesBy</big>** : returns a slice of values from the map that satisfy the given predicate function.
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/en/api/packages/maputil.md#FindValuesBy)]
    [[play](https://go.dev/play/p/bvNwNBZDm6v)]
+-   **<big>ToMarkdownTable</big>** : Convert a map slice data to a Markdown table string. It supports custom header display names and column display order.
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/en/api/packages/maputil.md#ToMarkdownTable)]
+    [[play](https://go.dev/play/p/todo)]
+

 <h3 id="mathutil"> 13. Mathutil package implements some functions for math calculation. &nbsp; &nbsp; &nbsp; &nbsp;<a href="#index">index</a></h3>

@@ -1819,30 +1823,50 @@ import "github.com/duke-git/lancet/v2/structs"

 -   **<big>New</big>** : creates a `Struct` instance.
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/en/api/packages/struct.md#New)]
+    [[play](https://go.dev/play/p/O29l8kk-Z17)]
 -   **<big>ToMap</big>** : converts a valid struct to a map.
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/en/api/packages/struct.md#ToMap)]
+    [[play](https://go.dev/play/p/qQbLySBgerZ)]
 -   **<big>Fields</big>** : get all fields of a given struct, that the fields are abstract struct field.
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/en/api/packages/struct.md#Fields)]
+    [[play](https://go.dev/play/p/w3Kk_CyVY7D)]
+-   **<big>Field</big>** : get an abstract field of a struct by given field name
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/api/packages/struct.md#Field)]
+    [[play](https://go.dev/play/p/KocZMSYarza)]
 -   **<big>IsStruct</big>** : check if the struct is valid.
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/en/api/packages/struct.md#IsStruct)]
+    [[play](https://go.dev/play/p/bU2FSdkbK1C)]
 -   **<big>Tag</big>** : get a `Tag` of the `Field`, `Tag` is a abstract struct field tag.
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/en/api/packages/struct.md#Tag)]
+    [[play](https://go.dev/play/p/DVrx5HvvUJr)]
 -   **<big>Name</big>** : get the field name.
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/en/api/packages/struct.md#Name)]
+    [[play](https://go.dev/play/p/zfIGlqsatee)]
 -   **<big>Value</big>** : get the `Field` underlying value.
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/en/api/packages/struct.md#Value)]
+    [[play](https://go.dev/play/p/qufYEU2o4Oi)]
 -   **<big>Kind</big>** : get the field's kind.
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/en/api/packages/struct.md#Kind)]
+    [[play](https://go.dev/play/p/wg4NlcUNG5o)]
 -   **<big>IsEmbedded</big>** : check if the field is an embedded field.
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/en/api/packages/struct.md#IsEmbedded)]
+    [[play](https://go.dev/play/p/wV2PrbYm3Ec)]
 -   **<big>IsExported</big>** : check if the field is exported.
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/en/api/packages/struct.md#IsExported)]
+    [[play](https://go.dev/play/p/csK4AXYaNbJ)]
 -   **<big>IsZero</big>** : check if the field is zero value.
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/en/api/packages/struct.md#IsZero)]
+    [[play](https://go.dev/play/p/RzqpGISf87r)]
 -   **<big>IsSlice</big>** : check if the field is a slice.
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/en/api/packages/struct.md#IsSlice)]
+    [[play](https://go.dev/play/p/MKz4CgBIUrU)]
 -   **<big>IsTargetType</big>** : check if the field is target type.
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/en/api/packages/struct.md#IsTargetType)]
+    [[play](https://go.dev/play/p/Ig75P-agN39)]
+-   **<big>TypeName</big>** : Return struct type name.
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/en/api/packages/struct.md#TypeName)]
+    [[play](https://go.dev/play/p/todo)]
+

 <h3 id="strutil"> 21. Strutil package contains some functions to manipulate string. &nbsp; &nbsp; &nbsp; &nbsp;<a href="#index">index</a></h3>

@@ -2301,6 +2325,12 @@ import "github.com/duke-git/lancet/v2/validator"
 -   **<big>IsChinaUnionPay</big>** : check if a give string is a valid china union pay number or not.
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/en/api/packages/validator.md#IsChinaUnionPay)]
    [[play](https://go.dev/play/p/yafpdxLiymu)]
+-   **<big>IsPassport</big>** : Passport validation(using regex).
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/en/api/packages/validator.md#IsPassport)]
+    [[play](https://go.dev/play/p/todo)]
+-   **<big>IsChineseHMPassport</big>** : Mainland travel permit for Hong Kong, Macao validation (using regex). 
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/en/api/packages/validator.md#IsChineseHMPassport)]
+    [[play](https://go.dev/play/p/todo)]

 <h3 id="xerror"> 25. Xerror package implements helpers for errors. &nbsp; &nbsp; &nbsp; &nbsp;<a href="#index">index</a></h3>

--- a/README_zh-CN.md
+++ b/README_zh-CN.md
@@ -1135,6 +1135,9 @@ import "github.com/duke-git/lancet/v2/maputil"
 -   **<big>FindValuesBy</big>** : 返回一个切片，包含满足给定谓词判断函数的 map 中的值。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/api/packages/maputil.md#FindValuesBy)]
    [[play](https://go.dev/play/p/bvNwNBZDm6v)]
+-   **<big>ToMarkdownTable</big>** : 将一个 map 切片数据转换为 Markdown 表格字符串。支持自定义表头显示名称和列的显示顺序。
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/api/packages/maputil.md#ToMarkdownTable)]
+    [[play](https://go.dev/play/p/todo)]

 <h3 id="mathutil"> 14. mathutil 包实现了一些数学计算的函数。&nbsp; &nbsp; &nbsp; &nbsp;<a href="#index">回到目录</a></h3>

@@ -1825,32 +1828,50 @@ import "github.com/duke-git/lancet/v2/structs"

 -   **<big>New</big>** : `Struct`结构体的构造函数。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/api/packages/struct.md#New)]
+    [[play](https://go.dev/play/p/O29l8kk-Z17)]
 -   **<big>ToMap</big>** : 将一个合法的 struct 对象转换为 map[string]any。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/api/packages/struct.md#ToMap)]
+    [[play](https://go.dev/play/p/qQbLySBgerZ)]
 -   **<big>Fields</big>** : 获取一个 struct 对象的属性列表。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/api/packages/struct.md#Fields)]
+    [[play](https://go.dev/play/p/w3Kk_CyVY7D)]
 -   **<big>Field</big>** : 根据属性名获取一个 struct 对象的属性。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/api/packages/struct.md#Fields)]
+    [[play](https://go.dev/play/p/KocZMSYarza)]
 -   **<big>IsStruct</big>** : 判断是否为一个合法的 struct 对象。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/api/packages/struct.md#IsStruct)]
+    [[play](https://go.dev/play/p/bU2FSdkbK1C)]
 -   **<big>Tag</big>** : 获取`Field`的`Tag`，默认的 tag key 是 json。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/api/packages/struct.md#Tag)]
+    [[play](https://go.dev/play/p/DVrx5HvvUJr)]
 -   **<big>Name</big>** : 获取属性名。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/api/packages/struct.md#Name)]
+    [[play](https://go.dev/play/p/zfIGlqsatee)]
 -   **<big>Value</big>** : 获取`Field`属性的值。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/api/packages/struct.md#Value)]
+    [[play](https://go.dev/play/p/qufYEU2o4Oi)]
 -   **<big>Kind</big>** : 获取属性 Kind。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/api/packages/struct.md#Kind)]
+    [[play](https://go.dev/play/p/wg4NlcUNG5o)]
 -   **<big>IsEmbedded</big>** : 判断属性是否为嵌入。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/api/packages/struct.md#IsEmbedded)]
+    [[play](https://go.dev/play/p/wV2PrbYm3Ec)]
 -   **<big>IsExported</big>** : 判断属性是否导出。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/api/packages/struct.md#IsExported)]
+    [[play](https://go.dev/play/p/csK4AXYaNbJ)]
 -   **<big>IsZero</big>** : 判断属性是否为零值。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/api/packages/struct.md#IsZero)]
+    [[play](https://go.dev/play/p/RzqpGISf87r)]
 -   **<big>IsSlice</big>** : 判断属性是否是切片。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/api/packages/struct.md#IsSlice)]
+    [[play](https://go.dev/play/p/MKz4CgBIUrU)]
 -   **<big>IsTargetType</big>** : 判断属性是否是目标类型。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/api/packages/struct.md#IsTargetType)]
+    [[play](https://go.dev/play/p/Ig75P-agN39)]
+-   **<big>TypeName</big>** : 获取结构体类型名。
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/api/packages/struct.md#TypeName)]
+    [[play](https://go.dev/play/p/todo)]
+

 <h3 id="strutil"> 22. strutil 包含字符串处理的相关函数。&nbsp; &nbsp; &nbsp; &nbsp;<a href="#index">回到目录</a></h3>

@@ -2310,7 +2331,12 @@ import "github.com/duke-git/lancet/v2/validator"
 -   **<big>IsChinaUnionPay</big>** : 检查字符串是否是有效的中国银联卡号。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/api/packages/validator.md#IsChinaUnionPay)]
    [[play](https://go.dev/play/p/yafpdxLiymu)]
-
+-   **<big>IsPassport</big>** : 判断护照(正则判断)。
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/api/packages/validator.md#IsPassport)]
+    [[play](https://go.dev/play/p/todo)]
+-   **<big>IsChineseHMPassport</big>** : 判断港澳台通行证(正则判断)。
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/api/packages/validator.md#IsChineseHMPassport)]
+    [[play](https://go.dev/play/p/todo)]
 <h3 id="xerror"> 26. xerror 包实现一些错误处理函数。&nbsp; &nbsp; &nbsp; &nbsp;<a href="#index">回到目录</a></h3>

 ```go
--- a/docs/.vitepress/en.ts
+++ b/docs/.vitepress/en.ts
@@ -114,6 +114,7 @@ export const enConfig: LocaleSpecificConfig<DefaultTheme.Config> = {
                            ],
                        },
                        { text: 'datetime', link: '/en/api/packages/datetime' },
+                        { text: 'enum', link: '/en/api/packages/enum' },
                        { text: 'eventbus', link: '/en/api/packages/eventbus' },
                        { text: 'fileutil', link: '/en/api/packages/fileutil' },
                        { text: 'formatter', link: '/en/api/packages/formatter' },
@@ -128,9 +129,9 @@ export const enConfig: LocaleSpecificConfig<DefaultTheme.Config> = {
                        { text: 'stream', link: '/en/api/packages/stream' },
                        { text: 'struct', link: '/en/api/packages/struct' },
                        { text: 'strutil', link: '/en/api/packages/strutil' },
-                        { text: 'system', link: '/en/api/packages/system' },
                        { text: 'tuple', link: '/en/api/packages/tuple' },
                        { text: 'validator', link: '/en/api/packages/validator' },
+                        { text: 'system', link: '/en/api/packages/system' },
                        { text: 'xerror', link: '/en/api/packages/xerror' },
                    ],
                },
--- a/docs/.vitepress/zh.ts
+++ b/docs/.vitepress/zh.ts
@@ -128,7 +128,7 @@ export const zhConfig: LocaleSpecificConfig<DefaultTheme.Config> = {
                        },
                        { text: '日期&时间', link: '/api/packages/datetime' },
                        { text: '事件总线', link: '/api/packages/eventbus' },
-                        { text: '文件', link: '/api/packages/fileutil' },
+                        { text: '文件处理', link: '/api/packages/fileutil' },
                        { text: '格式化工具', link: '/api/packages/formatter' },
                        { text: '函数', link: '/api/packages/function' },
                        { text: '数学工具', link: '/api/packages/mathutil' },
@@ -141,9 +141,10 @@ export const zhConfig: LocaleSpecificConfig<DefaultTheme.Config> = {
                        { text: '流', link: '/api/packages/stream' },
                        { text: '结构体', link: '/api/packages/struct' },
                        { text: '字符串', link: '/api/packages/strutil' },
-                        { text: '系统', link: '/api/packages/system' },
+                        { text: '枚举', link: '/api/packages/enum' },
                        { text: '元组', link: '/api/packages/tuple' },
                        { text: '验证器', link: '/api/packages/validator' },
+                        { text: '系统工具函数', link: '/api/packages/system' },
                        { text: '错误处理', link: '/api/packages/xerror' },
                    ],
                },
--- a/docs/api/overview.md
+++ b/docs/api/overview.md
@@ -46,6 +46,7 @@ outline: deep
        <div class="package-cell">cryptor</div>
        <div class="package-cell">datastructure</div>
        <div class="package-cell">datetime</div>
+        <div class="package-cell">enum</div>
        <div class="package-cell">eventbus</div>
        <div class="package-cell">fileutil</div>
        <div class="package-cell">formatter</div>
--- a/docs/api/packages/enum.md
+++ b/docs/api/packages/enum.md
@@ -0,0 +1,850 @@
+# Enum
+
+Enum实现一个简单枚举工具包。
+
+<div STYLE="page-break-after: always;"></div>
+
+## 源码:
+
+- [https://github.com/duke-git/lancet/blob/main/enum/enum.go](https://github.com/duke-git/lancet/blob/main/enum/enum.go)
+
+<div STYLE="page-break-after: always;"></div>
+
+## 用法:
+
+```go
+import (
+    "github.com/duke-git/lancet/v2/enum"
+)
+```
+
+<div STYLE="page-break-after: always;"></div>
+
+## 目录
+
+-   [NewItem](#NewItem)
+-   [NewItemsFromPairs](#NewItemsFromPairs)
+-   [Value](#Value)
+-   [Name](#Name)
+-   [Valid](#Valid)
+-   [MarshalJSON](#MarshalJSON)
+-   [NewRegistry](#NewRegistry)
+-   [Add](#Add)
+-   [Remove](#Remove)
+-   [Update](#Update)
+-   [GetByValue](#GetByValue)
+-   [GetByName](#GetByName)
+-   [Items](#Items)
+-   [Contains](#Contains)
+-   [Size](#Size)
+-   [Range](#Range)
+-   [SortedItems](#SortedItems)
+-   [Filter](#Filter)
+
+<div STYLE="page-break-after: always;"></div>
+
+## 文档
+
+### <span id="NewItem">NewItem</span>
+
+<p>创建枚举项。</p>
+
+<b>函数签名:</b>
+
+```go
+func NewItem[T comparable](value T, name string) *Item[T]
+```
+
+<b>示例:<span style="float:right;display:inline-block;">[运行](https://go.dev/play/p/todo)</span></b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/enum"
+)
+
+type Status int
+
+const (
+    Unknown Status = iota
+    Active
+    Inactive
+)
+
+func main() {
+    item1 := enum.NewItem(Active, "Active")
+    item2 := enum.NewItem(Inactive, "Inactive")
+
+    fmt.Println(item1.Name(), item1.Value())
+    fmt.Println(item2.Name(), item2.Value())
+
+    // Output:
+    // Active 1
+    // Inactive 2
+}
+```
+
+### <span id="NewItemsFromPairs">NewItemsFromPairs</span>
+
+<p>从Pair结构体的切片创建枚举项。</p>
+
+<b>函数签名:</b>
+
+```go
+func NewItemsFromPairs[T comparable](pairs ...Pair[T]) []*Item[T]
+```
+
+<b>示例:<span style="float:right;display:inline-block;">[运行](https://go.dev/play/p/todo)</span></b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/enum"
+)
+
+type Status int
+
+const (
+    Unknown Status = iota
+    Active
+    Inactive
+)
+
+func main() {
+    items := enum.NewItemsFromPairs(
+        enum.Pair[Status]{Value: Active, Name: "Active"},
+        enum.Pair[Status]{Value: Inactive, Name: "Inactive"},
+    )
+
+    fmt.Println(items[0].Name(), items[0].Value())
+    fmt.Println(items[1].Name(), items[1].Value())
+
+    // Output:
+    // Active 1
+    // Inactive 2
+}
+```
+
+### <span id="Value">Value</span>
+
+<p>返回枚举项的值。</p>
+
+<b>函数签名:</b>
+
+```go
+func (it *Item[T]) Value() T
+```
+
+<b>示例:<span style="float:right;display:inline-block;">[运行](https://go.dev/play/p/todo)</span></b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/enum"
+)
+
+type Status int
+
+const (
+    Unknown Status = iota
+    Active
+    Inactive
+)
+
+func main() {
+    items := enum.NewItemsFromPairs(
+        enum.Pair[Status]{Value: Active, Name: "Active"},
+        enum.Pair[Status]{Value: Inactive, Name: "Inactive"},
+    )
+
+    fmt.Println(items[0].Name(), items[0].Value())
+    fmt.Println(items[1].Name(), items[1].Value())
+
+    // Output:
+    // Active 1
+    // Inactive 2
+}
+```
+
+### <span id="Name">Name</span>
+
+<p>返回枚举项的名称。</p>
+
+<b>函数签名:</b>
+
+```go
+func (it *Item[T]) Name() string
+```
+
+<b>示例:<span style="float:right;display:inline-block;">[运行](https://go.dev/play/p/todo)</span></b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/enum"
+)
+
+type Status int
+
+const (
+    Unknown Status = iota
+    Active
+    Inactive
+)
+
+func main() {
+    items := enum.NewItemsFromPairs(
+        enum.Pair[Status]{Value: Active, Name: "Active"},
+        enum.Pair[Status]{Value: Inactive, Name: "Inactive"},
+    )
+
+    fmt.Println(items[0].Name(), items[0].Value())
+    fmt.Println(items[1].Name(), items[1].Value())
+
+    // Output:
+    // Active 1
+    // Inactive 2
+}
+```
+
+### <span id="Valid">Valid</span>
+
+<p>检查枚举项是否有效。如果提供了自定义检查函数，将使用该函数验证值。</p>
+
+<b>函数签名:</b>
+
+```go
+func (it *Item[T]) Valid(checker ...func(T) bool) bool
+```
+
+<b>示例:<span style="float:right;display:inline-block;">[运行](https://go.dev/play/p/todo)</span></b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/enum"
+)
+
+type Status int
+
+const (
+    Unknown Status = iota
+    Active
+    Inactive
+)
+
+func main() {
+    item := enum.NewItem(Active, "Active")
+    fmt.Println(item.Valid())
+
+    invalidItem := enum.NewItem(Unknown, "")
+    fmt.Println(invalidItem.Valid())
+
+    // Output:
+    // true
+    // false
+}
+```
+
+### <span id="MarshalJSON">MarshalJSON</span>
+
+<p>枚举项实现json.Marshaler 接口。</p>
+
+<b>函数签名:</b>
+
+```go
+func (it *Item[T]) MarshalJSON() ([]byte, error)
+func (it *Item[T]) UnmarshalJSON(data []byte) error
+```
+
+<b>示例:<span style="float:right;display:inline-block;">[运行](https://go.dev/play/p/todo)</span></b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/enum"
+)
+
+type Status int
+
+const (
+    Unknown Status = iota
+    Active
+    Inactive
+)
+
+func main() {
+    item := enum.NewItem(Active, "Active")
+    data, _ := item.MarshalJSON()
+    fmt.Println(string(data))
+
+    var unmarshaledItem Item[Status]
+    _ = unmarshaledItem.UnmarshalJSON(data)
+    fmt.Println(unmarshaledItem.Name(), unmarshaledItem.Value())
+
+    // Output:
+    // {"name":"Active","value":1}
+    // Active 1
+}
+```
+
+### <span id="NewRegistry">NewRegistry</span>
+
+<p>Registry 定义了一个通用的枚举注册表结构体。</p>
+
+<b>函数签名:</b>
+
+```go
+func NewRegistry[T comparable](items ...*Item[T]) *Registry[T]
+```
+
+<b>示例:<span style="float:right;display:inline-block;">[运行](https://go.dev/play/p/todo)</span></b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/enum"
+)
+
+type Status int
+
+const (
+    Unknown Status = iota
+    Active
+    Inactive
+)
+
+func main() {
+    registry := enum.NewRegistry[Status]()
+    item1 := enum.NewItem(Active, "Active")
+    item2 := enum.NewItem(Inactive, "Inactive")
+
+    registry.Add(item1, item2)
+
+    if item, found := registry.GetByValue(Active); found {
+        fmt.Println("Found by value:", item.Name())
+    }
+
+    if item, found := registry.GetByName("Inactive"); found {
+        fmt.Println("Found by name:", item.Value())
+    }
+
+    // Output:
+    // Found by value: Active
+    // Found by name: 2
+}
+```
+
+### <span id="Add">Add</span>
+
+<p>向枚举注册表添加枚举项。</p>
+
+<b>函数签名:</b>
+
+```go
+func (r *Registry[T]) Add(items ...*Item[T])
+```
+
+<b>示例:<span style="float:right;display:inline-block;">[运行](https://go.dev/play/p/todo)</span></b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/enum"
+)
+
+type Status int
+
+const (
+    Unknown Status = iota
+    Active
+    Inactive
+)
+
+func main() {
+    registry := enum.NewRegistry[Status]()
+    item1 := enum.NewItem(Active, "Active")
+    item2 := enum.NewItem(Inactive, "Inactive")
+
+    registry.Add(item1, item2)
+
+    if item, found := registry.GetByValue(Active); found {
+        fmt.Println("Found by value:", item.Name())
+    }
+
+    if item, found := registry.GetByName("Inactive"); found {
+        fmt.Println("Found by name:", item.Value())
+    }
+
+    // Output:
+    // Found by value: Active
+    // Found by name: 2
+}
+```
+
+### <span id="Remove">Remove</span>
+
+<p>在枚举注册表中删除枚举项。</p>
+
+<b>函数签名:</b>
+
+```go
+func (r *Registry[T]) Remove(value T) bool
+```
+
+<b>示例:<span style="float:right;display:inline-block;">[运行](https://go.dev/play/p/todo)</span></b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/enum"
+)
+
+type Status int
+
+const (
+    Unknown Status = iota
+    Active
+    Inactive
+)
+
+func main() {
+    registry := enum.NewRegistry[Status]()
+    item1 := enum.NewItem(Active, "Active")
+
+    registry.Add(item1)
+    fmt.Println("Size before removal:", registry.Size())
+
+    removed := registry.Remove(Active)
+    fmt.Println("Removed:", removed)
+    fmt.Println("Size after removal:", registry.Size())
+
+    // Output:
+    // Size before removal: 1
+    // Removed: true
+    // Size after removal: 0
+}
+```
+
+### <span id="Update">Update</span>
+
+<p>在枚举注册表中更新枚举项。</p>
+
+<b>函数签名:</b>
+
+```go
+func (r *Registry[T]) Update(value T, newName string) bool
+```
+
+<b>示例:<span style="float:right;display:inline-block;">[运行](https://go.dev/play/p/todo)</span></b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/enum"
+)
+
+type Status int
+
+const (
+    Unknown Status = iota
+    Active
+    Inactive
+)
+
+func main() {
+    registry := enum.NewRegistry[Status]()
+    item1 := enum.NewItem(Active, "Active")
+
+    registry.Add(item1)
+    updated := registry.Update(Active, "Activated")
+    fmt.Println("Updated:", updated)
+
+    if item, found := registry.GetByValue(Active); found {
+        fmt.Println("New name:", item.Name())
+    }
+
+    // Output:
+    // Updated: true
+    // New name: Activated
+}
+```
+
+### <span id="GetByValue">GetByValue</span>
+
+<p>在枚举注册表中通过值获取枚举项。</p>
+
+<b>函数签名:</b>
+
+```go
+func (r *Registry[T]) GetByValue(value T) (*Item[T], bool)
+```
+
+<b>示例:<span style="float:right;display:inline-block;">[运行](https://go.dev/play/p/todo)</span></b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/enum"
+)
+
+type Status int
+
+const (
+    Unknown Status = iota
+    Active
+    Inactive
+)
+
+func main() {
+    registry := enum.NewRegistry[Status]()
+    item1 := enum.NewItem(Active, "Active")
+
+    registry.Add(item1, item2)
+
+    if item, found := registry.GetByValue(Active); found {
+        fmt.Println("Found name by value:", item.Name())
+    }
+
+    // Output:
+    // Found name by value: Active
+}
+```
+
+### <span id="GetByName">GetByName</span>
+
+<p>在枚举注册表中通过名称获取枚举项。</p>
+
+<b>函数签名:</b>
+
+```go
+func (r *Registry[T]) GetByName(name string) (*Item[T], bool)
+```
+
+<b>示例:<span style="float:right;display:inline-block;">[运行](https://go.dev/play/p/todo)</span></b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/enum"
+)
+
+type Status int
+
+const (
+    Unknown Status = iota
+    Active
+    Inactive
+)
+
+func main() {
+    registry := enum.NewRegistry[Status]()
+    item := enum.NewItem(Active, "Active")
+
+    registry.Add(item)
+
+    if item, found := registry.GetByName("Active"); found {
+        fmt.Println("Found value by name:", item.Value())
+    }
+
+    // Output:
+    // Found value by name: 1
+}
+```
+
+### <span id="Items">Items</span>
+
+<p>返回枚举注册表中的枚举项。</p>
+
+<b>函数签名:</b>
+
+```go
+func (r *Registry[T]) Items() []*Item[T]
+```
+
+<b>示例:<span style="float:right;display:inline-block;">[运行](https://go.dev/play/p/todo)</span></b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/enum"
+)
+
+type Status int
+
+const (
+    Unknown Status = iota
+    Active
+    Inactive
+)
+
+func main() {
+    registry := enum.NewRegistry[Status]()
+    item1 := enum.NewItem(Active, "Active")
+    item2 := enum.NewItem(Inactive, "Inactive")
+
+    registry.Add(item1, item2)
+
+    for _, item := range registry.Items() {
+        fmt.Println(item.Name(), item.Value())
+    }
+
+    // Output:
+    // Active 1
+    // Inactive 2
+}
+```
+
+### <span id="Contains">Contains</span>
+
+<p>检查注册表中是否存在具有给定值的枚举项。</p>
+
+<b>函数签名:</b>
+
+```go
+func (r *Registry[T]) Contains(value T) bool
+```
+
+<b>示例:<span style="float:right;display:inline-block;">[运行](https://go.dev/play/p/todo)</span></b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/enum"
+)
+
+type Status int
+
+const (
+    Unknown Status = iota
+    Active
+    Inactive
+)
+
+func main() {
+    registry := enum.NewRegistry[Status]()
+    item := enum.NewItem(Active, "Active")
+    registry.Add(item)
+
+    fmt.Println(registry.Contains(Active))
+    fmt.Println(registry.Contains(Inactive))
+
+    // Output:
+    // true
+    // false
+}
+```
+
+### <span id="Size">Size</span>
+
+<p>返回注册表中枚举项的数目。</p>
+
+<b>函数签名:</b>
+
+```go
+func (r *Registry[T]) Size() int
+```
+
+<b>示例:<span style="float:right;display:inline-block;">[运行](https://go.dev/play/p/todo)</span></b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/enum"
+)
+
+type Status int
+
+const (
+    Unknown Status = iota
+    Active
+    Inactive
+)
+
+func main() {
+    registry := enum.NewRegistry[Status]()
+    fmt.Println("Initial size:", registry.Size())
+
+    item1 := enum.NewItem(Active, "Active")
+    item2 := enum.NewItem(Inactive, "Inactive")
+    registry.Add(item1, item2)
+
+    fmt.Println("Size after adding items:", registry.Size())
+
+    registry.Remove(Active)
+    fmt.Println("Size after removing an item:", registry.Size())
+
+    // Output:
+    // Initial size: 0
+    // Size after adding items: 2
+    // Size after removing an item: 1
+}
+```
+
+### <span id="Range">Range</span>
+
+<p>遍历注册表中的所有枚举项，并应用给定的函数。</p>
+
+<b>函数签名:</b>
+
+```go
+func (r *Registry[T]) Range(fn func(*Item[T]) bool)
+```
+
+<b>示例:<span style="float:right;display:inline-block;">[运行](https://go.dev/play/p/todo)</span></b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/enum"
+)
+
+type Status int
+
+const (
+    Unknown Status = iota
+    Active
+    Inactive
+)
+
+func main() {
+    registry := enum.NewRegistry[Status]()
+    item1 := enum.NewItem(Active, "Active")
+    item2 := enum.NewItem(Inactive, "Inactive")
+    registry.Add(item1, item2)
+
+    registry.Range(func(item *Item[Status]) bool {
+        fmt.Println(item.Name(), item.Value())
+        return true // continue iteration
+    })
+
+    // Output:
+    // Active 1
+    // Inactive 2
+}
+```
+
+### <span id="SortedItems">SortedItems</span>
+
+<p>返回按给定比较函数排序的所有枚举项的切片。</p>
+
+<b>函数签名:</b>
+
+```go
+func (r *Registry[T]) SortedItems(less func(*Item[T], *Item[T]) bool) []*Item[T]
+```
+
+<b>示例:<span style="float:right;display:inline-block;">[运行](https://go.dev/play/p/todo)</span></b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/enum"
+)
+
+type Status int
+
+const (
+    Unknown Status = iota
+    Active
+    Inactive
+)
+
+func main() {
+    registry := enum.NewRegistry[Status]()
+    item1 := enum.NewItem(Inactive, "Inactive")
+    item2 := enum.NewItem(Active, "Active")
+    registry.Add(item1, item2)
+
+    for _, item := range registry.SortedItems(func(i1, i2 *Item[Status]) bool {
+        return i1.value < i2.value
+    }) {
+        fmt.Println(item.Name(), item.Value())
+    }
+
+    // Output:
+    // Active 1
+    // Inactive 2
+}
+```
+
+### <span id="Filter">Filter</span>
+
+<p>返回满足给定谓词函数的枚举项切片。</p>
+
+<b>函数签名:</b>
+
+```go
+func (r *Registry[T]) Filter(predicate func(*Item[T]) bool) []*Item[T]
+```
+
+<b>示例:<span style="float:right;display:inline-block;">[运行](https://go.dev/play/p/todo)</span></b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/enum"
+)
+
+type Status int
+
+const (
+    Unknown Status = iota
+    Active
+    Inactive
+)
+
+func main() {
+    registry := enum.NewRegistry[Status]()
+    item1 := enum.NewItem(Active, "Active")
+    item2 := enum.NewItem(Inactive, "Inactive")
+    registry.Add(item1, item2)
+
+    activeItems := registry.Filter(func(item *Item[Status]) bool {
+        return item.Value() == Active
+    })
+
+    for _, item := range activeItems {
+        fmt.Println(item.Name(), item.Value())
+    }
+
+    // Output:
+    // Active 1
+}
+```
--- a/docs/api/packages/maputil.md
+++ b/docs/api/packages/maputil.md
@@ -2357,7 +2357,7 @@ func main() {
 编辑
 func ToMarkdownTable(data []map[string]interface{}, headerMap map[string]string, columnOrder []string) string
 ```
-<b>示例:<span style="float:right;display:inline-block;">[运行]()</span></b>
+<b>示例:<span style="float:right;display:inline-block;">[运行](https://go.dev/play/p/todo)</span></b>


 ```go
--- a/docs/api/packages/struct.md
+++ b/docs/api/packages/struct.md
@@ -31,6 +31,7 @@ import (
 -   [IsStruct](#IsStruct)
 -   [Tag](#Tag)
 -   [Name](#Name)
+-   [TypeName](#TypeName)
 -   [Value](#Value)
 -   [Kind](#Kind)
 -   [IsEmbedded](#IsEmbedded)
@@ -53,7 +54,7 @@ import (
 func New(value any, tagName ...string) *Struct
 ```

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

 ```go
 package main
@@ -68,7 +69,11 @@ func main() {
    }
    p1 := &People{Name: "11"}
    s := structs.New(p1)
-    // to do something
+    
+    fmt.Println(s.ToMap())
+
+    // Output:
+    // map[name:11] <nil>
 }
 ```

@@ -88,7 +93,7 @@ func (s *Struct) ToMap() (map[string]any, error)
 func ToMap(v any) (map[string]any, error)
 ```

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

 ```go
 package main
@@ -129,7 +134,7 @@ func main() {
 func (s *Struct) Fields() []*Field
 ```

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

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

 ```go
-func (s *Struct) Field(name string) *Field
+func (s *Struct) Field(name string) (*Field, bool)
 ```

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

 ```go
 package main
@@ -180,12 +185,14 @@ func main() {
    }
    p1 := &People{Name: "11"}
    s := structs.New(p1)
-    f := s.Field("Name")
+    f, found := s.Field("Name")

    fmt.Println(f.Value())
+    fmt.Println(found)

    // Output:
    // 11
+    // true
 }
 ```

@@ -199,7 +206,7 @@ func main() {
 func (s *Struct) IsStruct() bool
 ```

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

 ```go
 package main
@@ -233,7 +240,7 @@ func main() {
 func (f *Field) Tag() *Tag
 ```

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

 ```go
 package main
@@ -270,7 +277,7 @@ func main() {
 func (f *Field) Value() any
 ```

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

 ```go
 package main
@@ -306,7 +313,7 @@ func main() {
 func (f *Field) IsEmbedded() bool
 ```

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

 ```go
 package main
@@ -351,7 +358,7 @@ func main() {
 func (f *Field) IsExported() bool
 ```

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

 ```go
 package main
@@ -390,7 +397,7 @@ func main() {
 func (f *Field) IsZero() bool
 ```

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

 ```go
 package main
@@ -429,7 +436,7 @@ func main() {
 func (f *Field) Name() string
 ```

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

 ```go
 package main
@@ -468,7 +475,7 @@ func main() {
 func (f *Field) Kind() reflect.Kind
 ```

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

 ```go
 package main
@@ -497,6 +504,42 @@ func main() {
 }
 ```

+### <span id="TypeName">TypeName</span>
+
+<p>获取结构体类型名。</p>
+
+<b>函数签名:</b>
+
+```go
+func (s *Struct) TypeName() string
+```
+
+<b>示例:<span style="float:right;display:inline-block;">[运行](https://go.dev/play/p/todo)</span></b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/structs"
+)
+
+func main() {
+    type Parent struct {
+        Name string
+        Age  int
+    }
+    
+    p := &Parent{Age: 11}
+    s := structs.New(p1)
+
+    fmt.Println(s.TypeName())
+    
+    // Output: 
+    // Parent
+}
+```
+
 ### <span id="IsSlice">IsSlice</span>

 <p>判断属性是否是切片</p>
@@ -507,7 +550,7 @@ func main() {
 func (f *Field) IsSlice() bool
 ```

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

 ```go
 package main
@@ -544,7 +587,7 @@ func main() {
 func (f *Field) IsTargetType(targetType reflect.Kind) bool
 ```

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

 ```go
 package main
--- a/docs/api/packages/validator.md
+++ b/docs/api/packages/validator.md
@@ -65,6 +65,8 @@ import (
 -   [IsAmericanExpress](#IsAmericanExpress)
 -   [IsUnionPay](#IsUnionPay)
 -   [IsChinaUnionPay](#IsChinaUnionPay)
+-   [IsPassport](#IsPassport)
+-   [IsChineseHMPassport](#IsChineseHMPassport)

 <div STYLE="page-break-after: always;"></div>

@@ -844,20 +846,20 @@ import (

 func main() {
    result1 := validator.IsAlphaNumeric("ABC")
-	result2 := validator.IsAlphaNumeric("123")
-	result3 := validator.IsAlphaNumeric("abc123")
-	result4 := validator.IsAlphaNumeric("abc123@#$")
+    result2 := validator.IsAlphaNumeric("123")
+    result3 := validator.IsAlphaNumeric("abc123")
+    result4 := validator.IsAlphaNumeric("abc123@#$")

-	fmt.Println(result1)
-	fmt.Println(result2)
-	fmt.Println(result3)
-	fmt.Println(result4)
+    fmt.Println(result1)
+    fmt.Println(result2)
+    fmt.Println(result3)
+    fmt.Println(result4)

-	// Output:
-	// true
-	// true
-	// true
-	// false
+    // Output:
+    // true
+    // true
+    // true
+    // false
 }
 ```

@@ -1567,3 +1569,80 @@ func main() {
    // false
 }
 ```
+
+### <span id="IsPassport">IsPassport</span>
+
+<p>判断护照(正则判断)。</p>
+
+<b>函数签名:</b>
+
+```go
+func IsPassport(passport, country string) bool
+```
+
+<b>示例:<span style="float:right;display:inline-block">[运行](https://go.dev/play/p/todo)</span></b>
+
+```go
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/validator"
+)
+
+func main() {
+    result1 := validator.IsPassport("P123456789", "CN")
+    result2 := validator.IsPassport("123456789", "US")
+    result3 := validator.IsPassport("AB1234567", "RU")
+    result4 := validator.IsPassport("123456789", "CN")
+
+    fmt.Println(result1)
+    fmt.Println(result2)
+    fmt.Println(result3)
+    fmt.Println(result4)
+
+    // Output:
+    // true
+    // true
+    // true
+    // false
+}
+```
+
+### <span id="IsChineseHMPassport">IsChineseHMPassport</span>
+
+<p>判断港澳台通行证(正则判断)。</p>
+
+<b>函数签名:</b>
+
+```go
+func IsChineseHMPassport(hmPassport string) bool
+```
+
+<b>示例:<span style="float:right;display:inline-block">[运行](https://go.dev/play/p/todo)</span></b>
+
+```go
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/validator"
+)
+
+func main() {
+    result1 := validator.IsChineseHMPassport("C12345678")
+    result2 := validator.IsChineseHMPassport("C00000000")
+    result3 := validator.IsChineseHMPassport("M12345678")
+    result4 := validator.IsChineseHMPassport("c12345678")
+    result5 := validator.IsChineseHMPassport("C1234567")
+
+    fmt.Println(result1)
+    fmt.Println(result2)
+    fmt.Println(result3)
+    fmt.Println(result4)
+    fmt.Println(result5)
+
+    // Output:
+    // true
+    // true
+    // true
+    // false
+    // false
+}
+```
--- a/docs/en/api/overview.md
+++ b/docs/en/api/overview.md
@@ -46,6 +46,7 @@ outline: deep
        <div class="package-cell">cryptor</div>
        <div class="package-cell">datastructure</div>
        <div class="package-cell">datetime</div>
+        <div class="package-cell">enum</div>
        <div class="package-cell">eventbus</div>
        <div class="package-cell">fileutil</div>
        <div class="package-cell">formatter</div>
--- a/docs/en/api/packages/enum.md
+++ b/docs/en/api/packages/enum.md
@@ -0,0 +1,850 @@
+# Enum
+
+Package enum provides a simple enum implementation.
+
+<div STYLE="page-break-after: always;"></div>
+
+## Source:
+
+- [https://github.com/duke-git/lancet/blob/main/enum/enum.go](https://github.com/duke-git/lancet/blob/main/enum/enum.go)
+
+<div STYLE="page-break-after: always;"></div>
+
+## Usage:
+
+```go
+import (
+    "github.com/duke-git/lancet/v2/enum"
+)
+```
+
+<div STYLE="page-break-after: always;"></div>
+
+## Index
+
+-   [NewItem](#NewItem)
+-   [NewItemsFromPairs](#NewItemsFromPairs)
+-   [Value](#Value)
+-   [Name](#Name)
+-   [Valid](#Valid)
+-   [MarshalJSON](#MarshalJSON)
+-   [NewRegistry](#NewRegistry)
+-   [Add](#Add)
+-   [Remove](#Remove)
+-   [Update](#Update)
+-   [GetByValue](#GetByValue)
+-   [GetByName](#GetByName)
+-   [Items](#Items)
+-   [Contains](#Contains)
+-   [Size](#Size)
+-   [Range](#Range)
+-   [SortedItems](#SortedItems)
+-   [Filter](#Filter)
+
+<div STYLE="page-break-after: always;"></div>
+
+## Documentation
+
+### <span id="NewItem">NewItem</span>
+
+<p>Creates a new enum item.</p>
+
+<b>Signature:</b>
+
+```go
+func NewItem[T comparable](value T, name string) *Item[T]
+```
+
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/todo)</span></b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/enum"
+)
+
+type Status int
+
+const (
+    Unknown Status = iota
+    Active
+    Inactive
+)
+
+func main() {
+    item1 := enum.NewItem(Active, "Active")
+    item2 := enum.NewItem(Inactive, "Inactive")
+
+    fmt.Println(item1.Name(), item1.Value())
+    fmt.Println(item2.Name(), item2.Value())
+
+    // Output:
+    // Active 1
+    // Inactive 2
+}
+```
+
+### <span id="NewItemsFromPairs">NewItemsFromPairs</span>
+
+<p>Creates enum items from a slice of Pair structs.</p>
+
+<b>Signature:</b>
+
+```go
+func NewItemsFromPairs[T comparable](pairs ...Pair[T]) []*Item[T]
+```
+
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/todo)</span></b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/enum"
+)
+
+type Status int
+
+const (
+    Unknown Status = iota
+    Active
+    Inactive
+)
+
+func main() {
+    items := enum.NewItemsFromPairs(
+        enum.Pair[Status]{Value: Active, Name: "Active"},
+        enum.Pair[Status]{Value: Inactive, Name: "Inactive"},
+    )
+
+    fmt.Println(items[0].Name(), items[0].Value())
+    fmt.Println(items[1].Name(), items[1].Value())
+
+    // Output:
+    // Active 1
+    // Inactive 2
+}
+```
+
+### <span id="Value">Value</span>
+
+<p>Returns the value of the enum item.</p>
+
+<b>Signature:</b>
+
+```go
+func (it *Item[T]) Value() T
+```
+
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/todo)</span></b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/enum"
+)
+
+type Status int
+
+const (
+    Unknown Status = iota
+    Active
+    Inactive
+)
+
+func main() {
+    items := enum.NewItemsFromPairs(
+        enum.Pair[Status]{Value: Active, Name: "Active"},
+        enum.Pair[Status]{Value: Inactive, Name: "Inactive"},
+    )
+
+    fmt.Println(items[0].Name(), items[0].Value())
+    fmt.Println(items[1].Name(), items[1].Value())
+
+    // Output:
+    // Active 1
+    // Inactive 2
+}
+```
+
+### <span id="Name">Name</span>
+
+<p>Returns the name of the enum item.</p>
+
+<b>Signature:</b>
+
+```go
+func (it *Item[T]) Name() string
+```
+
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/todo)</span></b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/enum"
+)
+
+type Status int
+
+const (
+    Unknown Status = iota
+    Active
+    Inactive
+)
+
+func main() {
+    items := enum.NewItemsFromPairs(
+        enum.Pair[Status]{Value: Active, Name: "Active"},
+        enum.Pair[Status]{Value: Inactive, Name: "Inactive"},
+    )
+
+    fmt.Println(items[0].Name(), items[0].Value())
+    fmt.Println(items[1].Name(), items[1].Value())
+
+    // Output:
+    // Active 1
+    // Inactive 2
+}
+```
+
+### <span id="Valid">Valid</span>
+
+<p>Checks if the enum item is valid. If a custom check function is provided, it will be used to validate the value.</p>
+
+<b>Signature:</b>
+
+```go
+func (it *Item[T]) Valid(checker ...func(T) bool) bool
+```
+
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/todo)</span></b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/enum"
+)
+
+type Status int
+
+const (
+    Unknown Status = iota
+    Active
+    Inactive
+)
+
+func main() {
+    item := enum.NewItem(Active, "Active")
+    fmt.Println(item.Valid())
+
+    invalidItem := enum.NewItem(Unknown, "")
+    fmt.Println(invalidItem.Valid())
+
+    // Output:
+    // true
+    // false
+}
+```
+
+### <span id="MarshalJSON">MarshalJSON</span>
+
+<p>Implementation of json.Marshaler interface.</p>
+
+<b>Signature:</b>
+
+```go
+func (it *Item[T]) MarshalJSON() ([]byte, error)
+func (it *Item[T]) UnmarshalJSON(data []byte) error
+```
+
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/todo)</span></b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/enum"
+)
+
+type Status int
+
+const (
+    Unknown Status = iota
+    Active
+    Inactive
+)
+
+func main() {
+    item := enum.NewItem(Active, "Active")
+    data, _ := item.MarshalJSON()
+    fmt.Println(string(data))
+
+    var unmarshaledItem Item[Status]
+    _ = unmarshaledItem.UnmarshalJSON(data)
+    fmt.Println(unmarshaledItem.Name(), unmarshaledItem.Value())
+
+    // Output:
+    // {"name":"Active","value":1}
+    // Active 1
+}
+```
+
+### <span id="NewRegistry">NewRegistry</span>
+
+<p>Creates a new enum registry.</p>
+
+<b>Signature:</b>
+
+```go
+func NewRegistry[T comparable](items ...*Item[T]) *Registry[T]
+```
+
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/todo)</span></b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/enum"
+)
+
+type Status int
+
+const (
+    Unknown Status = iota
+    Active
+    Inactive
+)
+
+func main() {
+    registry := enum.NewRegistry[Status]()
+    item1 := enum.NewItem(Active, "Active")
+    item2 := enum.NewItem(Inactive, "Inactive")
+
+    registry.Add(item1, item2)
+
+    if item, found := registry.GetByValue(Active); found {
+        fmt.Println("Found by value:", item.Name())
+    }
+
+    if item, found := registry.GetByName("Inactive"); found {
+        fmt.Println("Found by name:", item.Value())
+    }
+
+    // Output:
+    // Found by value: Active
+    // Found by name: 2
+}
+```
+
+### <span id="Add">Add</span>
+
+<p>Adds enum items to the registry.</p>
+
+<b>Signature:</b>
+
+```go
+func (r *Registry[T]) Add(items ...*Item[T])
+```
+
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/todo)</span></b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/enum"
+)
+
+type Status int
+
+const (
+    Unknown Status = iota
+    Active
+    Inactive
+)
+
+func main() {
+    registry := enum.NewRegistry[Status]()
+    item1 := enum.NewItem(Active, "Active")
+    item2 := enum.NewItem(Inactive, "Inactive")
+
+    registry.Add(item1, item2)
+
+    if item, found := registry.GetByValue(Active); found {
+        fmt.Println("Found by value:", item.Name())
+    }
+
+    if item, found := registry.GetByName("Inactive"); found {
+        fmt.Println("Found by name:", item.Value())
+    }
+
+    // Output:
+    // Found by value: Active
+    // Found by name: 2
+}
+```
+
+### <span id="Remove">Remove</span>
+
+<p>Removes an enum item from the registry by its value.</p>
+
+<b>Signature:</b>
+
+```go
+func (r *Registry[T]) Remove(value T) bool
+```
+
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/todo)</span></b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/enum"
+)
+
+type Status int
+
+const (
+    Unknown Status = iota
+    Active
+    Inactive
+)
+
+func main() {
+    registry := enum.NewRegistry[Status]()
+    item1 := enum.NewItem(Active, "Active")
+
+    registry.Add(item1)
+    fmt.Println("Size before removal:", registry.Size())
+
+    removed := registry.Remove(Active)
+    fmt.Println("Removed:", removed)
+    fmt.Println("Size after removal:", registry.Size())
+
+    // Output:
+    // Size before removal: 1
+    // Removed: true
+    // Size after removal: 0
+}
+```
+
+### <span id="Update">Update</span>
+
+<p>Updates the name of an enum item in the registry by its value.</p>
+
+<b>Signature:</b>
+
+```go
+func (r *Registry[T]) Update(value T, newName string) bool
+```
+
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/todo)</span></b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/enum"
+)
+
+type Status int
+
+const (
+    Unknown Status = iota
+    Active
+    Inactive
+)
+
+func main() {
+    registry := enum.NewRegistry[Status]()
+    item1 := enum.NewItem(Active, "Active")
+
+    registry.Add(item1)
+    updated := registry.Update(Active, "Activated")
+    fmt.Println("Updated:", updated)
+
+    if item, found := registry.GetByValue(Active); found {
+        fmt.Println("New name:", item.Name())
+    }
+
+    // Output:
+    // Updated: true
+    // New name: Activated
+}
+```
+
+### <span id="GetByValue">GetByValue</span>
+
+<p>Retrieves an enum item by its value.</p>
+
+<b>Signature:</b>
+
+```go
+func (r *Registry[T]) GetByValue(value T) (*Item[T], bool)
+```
+
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/todo)</span></b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/enum"
+)
+
+type Status int
+
+const (
+    Unknown Status = iota
+    Active
+    Inactive
+)
+
+func main() {
+    registry := enum.NewRegistry[Status]()
+    item1 := enum.NewItem(Active, "Active")
+
+    registry.Add(item1, item2)
+
+    if item, found := registry.GetByValue(Active); found {
+        fmt.Println("Found name by value:", item.Name())
+    }
+
+    // Output:
+    // Found name by value: Active
+}
+```
+
+### <span id="GetByName">GetByName</span>
+
+<p>Retrieves an enum item by its name.</p>
+
+<b>Signature:</b>
+
+```go
+func (r *Registry[T]) GetByName(name string) (*Item[T], bool)
+```
+
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/todo)</span></b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/enum"
+)
+
+type Status int
+
+const (
+    Unknown Status = iota
+    Active
+    Inactive
+)
+
+func main() {
+    registry := enum.NewRegistry[Status]()
+    item := enum.NewItem(Active, "Active")
+
+    registry.Add(item)
+
+    if item, found := registry.GetByName("Active"); found {
+        fmt.Println("Found value by name:", item.Value())
+    }
+
+    // Output:
+    // Found value by name: 1
+}
+```
+
+### <span id="Items">Items</span>
+
+<p>Returns a slice of all enum items in the registry.</p>
+
+<b>Signature:</b>
+
+```go
+func (r *Registry[T]) Items() []*Item[T]
+```
+
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/todo)</span></b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/enum"
+)
+
+type Status int
+
+const (
+    Unknown Status = iota
+    Active
+    Inactive
+)
+
+func main() {
+    registry := enum.NewRegistry[Status]()
+    item1 := enum.NewItem(Active, "Active")
+    item2 := enum.NewItem(Inactive, "Inactive")
+
+    registry.Add(item1, item2)
+
+    for _, item := range registry.Items() {
+        fmt.Println(item.Name(), item.Value())
+    }
+
+    // Output:
+    // Active 1
+    // Inactive 2
+}
+```
+
+### <span id="Contains">Contains</span>
+
+<p>Checks if an enum item with the given value exists in the registry.</p>
+
+<b>Signature:</b>
+
+```go
+func (r *Registry[T]) Contains(value T) bool
+```
+
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/todo)</span></b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/enum"
+)
+
+type Status int
+
+const (
+    Unknown Status = iota
+    Active
+    Inactive
+)
+
+func main() {
+    registry := enum.NewRegistry[Status]()
+    item := enum.NewItem(Active, "Active")
+    registry.Add(item)
+
+    fmt.Println(registry.Contains(Active))
+    fmt.Println(registry.Contains(Inactive))
+
+    // Output:
+    // true
+    // false
+}
+```
+
+### <span id="Size">Size</span>
+
+<p>Returns the number of enum items in the registry.</p>
+
+<b>Signature:</b>
+
+```go
+func (r *Registry[T]) Size() int
+```
+
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/todo)</span></b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/enum"
+)
+
+type Status int
+
+const (
+    Unknown Status = iota
+    Active
+    Inactive
+)
+
+func main() {
+    registry := enum.NewRegistry[Status]()
+    fmt.Println("Initial size:", registry.Size())
+
+    item1 := enum.NewItem(Active, "Active")
+    item2 := enum.NewItem(Inactive, "Inactive")
+    registry.Add(item1, item2)
+
+    fmt.Println("Size after adding items:", registry.Size())
+
+    registry.Remove(Active)
+    fmt.Println("Size after removing an item:", registry.Size())
+
+    // Output:
+    // Initial size: 0
+    // Size after adding items: 2
+    // Size after removing an item: 1
+}
+```
+
+### <span id="Range">Range</span>
+
+<p>Iterates over all enum items in the registry and applies the given function.</p>
+
+<b>Signature:</b>
+
+```go
+func (r *Registry[T]) Range(fn func(*Item[T]) bool)
+```
+
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/todo)</span></b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/enum"
+)
+
+type Status int
+
+const (
+    Unknown Status = iota
+    Active
+    Inactive
+)
+
+func main() {
+    registry := enum.NewRegistry[Status]()
+    item1 := enum.NewItem(Active, "Active")
+    item2 := enum.NewItem(Inactive, "Inactive")
+    registry.Add(item1, item2)
+
+    registry.Range(func(item *Item[Status]) bool {
+        fmt.Println(item.Name(), item.Value())
+        return true // continue iteration
+    })
+
+    // Output:
+    // Active 1
+    // Inactive 2
+}
+```
+
+### <span id="SortedItems">SortedItems</span>
+
+<p>Returns a slice of all enum items sorted by the given less function.</p>
+
+<b>Signature:</b>
+
+```go
+func (r *Registry[T]) SortedItems(less func(*Item[T], *Item[T]) bool) []*Item[T]
+```
+
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/todo)</span></b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/enum"
+)
+
+type Status int
+
+const (
+    Unknown Status = iota
+    Active
+    Inactive
+)
+
+func main() {
+    registry := enum.NewRegistry[Status]()
+    item1 := enum.NewItem(Inactive, "Inactive")
+    item2 := enum.NewItem(Active, "Active")
+    registry.Add(item1, item2)
+
+    for _, item := range registry.SortedItems(func(i1, i2 *Item[Status]) bool {
+        return i1.value < i2.value
+    }) {
+        fmt.Println(item.Name(), item.Value())
+    }
+
+    // Output:
+    // Active 1
+    // Inactive 2
+}
+```
+
+### <span id="Filter">Filter</span>
+
+<p>Returns a slice of enum items that satisfy the given predicate function.</p>
+
+<b>Signature:</b>
+
+```go
+func (r *Registry[T]) Filter(predicate func(*Item[T]) bool) []*Item[T]
+```
+
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/todo)</span></b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/enum"
+)
+
+type Status int
+
+const (
+    Unknown Status = iota
+    Active
+    Inactive
+)
+
+func main() {
+    registry := enum.NewRegistry[Status]()
+    item1 := enum.NewItem(Active, "Active")
+    item2 := enum.NewItem(Inactive, "Inactive")
+    registry.Add(item1, item2)
+
+    activeItems := registry.Filter(func(item *Item[Status]) bool {
+        return item.Value() == Active
+    })
+
+    for _, item := range activeItems {
+        fmt.Println(item.Name(), item.Value())
+    }
+
+    // Output:
+    // Active 1
+}
+```
--- a/docs/en/api/packages/maputil.md
+++ b/docs/en/api/packages/maputil.md
@@ -79,6 +79,8 @@ import (
 -   [SortByKey](#SortByKey)
 -   [GetOrDefault](#GetOrDefault)
 -   [FindValuesBy](#FindValuesBy)
+-   [ToMarkdownTable](#ToMarkdownTable)
+

 <div STYLE="page-break-after: always;"></div>

@@ -2363,3 +2365,69 @@ func main() {
    // [b d]
 }
 ```
+
+### <span id="ToMarkdownTable">ToMarkdownTable</span>
+
+<p>Convert a map slice data to a Markdown table string. It supports custom header display names and column display order.</p>
+
+<b>Signature:</b>
+
+```go
+编辑
+func ToMarkdownTable(data []map[string]interface{}, headerMap map[string]string, columnOrder []string) string
+```
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/todo)</span></b>
+
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/maputil"
+)
+
+func main() {
+    // basic usage: automatically extract column names from data as table headers
+
+    data := []map[string]interface{}{
+        {"name": "Alice", "age": 25, "salary": 50000},
+        {"name": "Bob", "age": 30, "salary": 60000},
+    }
+
+    result := maputil.ToMarkdownTable(data, nil, nil)
+    fmt.Println(result)
+
+    // output:
+    // |name|age|salary|
+    // |---|---|---|
+    // |Alice|25|50000|
+    // |Bob|30|60000|
+
+    // custom header name
+    headerMap := map[string]string{
+        "name":   "n",
+        "age":    "a",
+        "salary": "s",
+    }
+    result = maputil.ToMarkdownTable(data, headerMap, nil)
+    fmt.Println(result)
+
+    // ouput:
+    // |m|a|s|
+    // |---|---|---|
+    // |Alice|25|50000|
+    // |Bob|30|60000|
+
+    // custom column display order
+    columnOrder := []string{"salary", "name"}
+    result = maputil.ToMarkdownTable(data, nil, columnOrder)
+    fmt.Println(result)
+
+    // 输出:
+    // |salary|name|
+    // |---|---|
+    // |50000|Alice|
+    // |60000|Bob|
+}
+```
--- a/docs/en/api/packages/struct.md
+++ b/docs/en/api/packages/struct.md
@@ -31,6 +31,7 @@ import (
 -   [IsStruct](#IsStruct)
 -   [Tag](#Tag)
 -   [Name](#Name)
+-   [TypeName](#TypeName)
 -   [Value](#Value)
 -   [Kind](#Kind)
 -   [IsEmbedded](#IsEmbedded)
@@ -53,12 +54,13 @@ import (
 func New(value any, tagName ...string) *Struct
 ```

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

 ```go
 package main

 import (
+    "fmt"
    "github.com/duke-git/lancet/v2/structs"
 )

@@ -68,7 +70,11 @@ func main() {
    }
    p1 := &People{Name: "11"}
    s := structs.New(p1)
-    // to do something
+    
+    fmt.Println(s.ToMap())
+
+    // Output:
+    // map[name:11] <nil>
 }
 ```

@@ -88,7 +94,7 @@ func (s *Struct) ToMap() (map[string]any, error)
 func ToMap(v any) (map[string]any, error)
 ```

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

 ```go
 package main
@@ -130,7 +136,7 @@ func main() {
 func (s *Struct) Fields() []*Field
 ```

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

 ```go
 package main
@@ -162,10 +168,10 @@ func main() {
 <b>Signature:</b>

 ```go
-func (s *Struct) Field(name string) *Field
+func (s *Struct) Field(name string) (*Field, bool)
 ```

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

 ```go
 package main
@@ -181,12 +187,14 @@ func main() {
    }
    p1 := &People{Name: "11"}
    s := structs.New(p1)
-    f := s.Field("Name")
+    f, found := s.Field("Name")

    fmt.Println(f.Value())
+    fmt.Println(found)

    // Output:
    // 11
+    // true
 }
 ```

@@ -200,7 +208,7 @@ func main() {
 func (s *Struct) IsStruct() bool
 ```

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

 ```go
 package main
@@ -234,7 +242,7 @@ func main() {
 func (f *Field) Tag() *Tag
 ```

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

 ```go
 package main
@@ -271,7 +279,7 @@ func main() {
 func (f *Field) Value() any
 ```

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

 ```go
 package main
@@ -307,7 +315,7 @@ func main() {
 func (f *Field) IsEmbedded() bool
 ```

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

 ```go
 package main
@@ -352,7 +360,7 @@ func main() {
 func (f *Field) IsExported() bool
 ```

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

 ```go
 package main
@@ -391,7 +399,7 @@ func main() {
 func (f *Field) IsZero() bool
 ```

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

 ```go
 package main
@@ -430,7 +438,7 @@ func main() {
 func (f *Field) Name() string
 ```

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

 ```go
 package main
@@ -469,7 +477,7 @@ func main() {
 func (f *Field) Kind() reflect.Kind
 ```

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

 ```go
 package main
@@ -498,6 +506,42 @@ func main() {
 }
 ```

+### <span id="TypeName">TypeName</span>
+
+<p>Return struct type name.</p>
+
+<b>Signature:</b>
+
+```go
+func (s *Struct) TypeName() string
+```
+
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/todo)</span></b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/structs"
+)
+
+func main() {
+    type Parent struct {
+        Name string
+        Age  int
+    }
+
+    p := &Parent{Age: 11}
+    s := structs.New(p1)
+
+    fmt.Println(s.TypeName())
+    
+    // Output: 
+    // Parent
+}
+```
+
 ### <span id="IsSlice">IsSlice</span>

 <p>Check if the field is a slice</p>
@@ -508,7 +552,7 @@ func main() {
 func (f *Field) IsSlice() bool
 ```

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

 ```go
 package main
@@ -545,7 +589,7 @@ func main() {
 func (f *Field) IsTargetType(targetType reflect.Kind) bool
 ```

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

 ```go
 package main
--- a/docs/en/api/packages/validator.md
+++ b/docs/en/api/packages/validator.md
@@ -65,6 +65,8 @@ import (
 -   [IsAmericanExpress](#IsAmericanExpress)
 -   [IsUnionPay](#IsUnionPay)
 -   [IsChinaUnionPay](#IsChinaUnionPay)
+-   [IsPassport](#IsPassport)
+-   [IsChineseHMPassport](#IsChineseHMPassport)

 <div STYLE="page-break-after: always;"></div>

@@ -1569,3 +1571,80 @@ func main() {
    // false
 }
 ```
+
+### <span id="IsPassport">IsPassport</span>
+
+<p>Passport validation(using regex).</p>
+
+<b>Signature:</b>
+
+```go
+func IsPassport(passport, country string) bool
+```
+
+<b>Example:<span style="float:right;display:inline-block">[Run](https://go.dev/play/p/todo)</span></b>
+
+```go
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/validator"
+)
+
+func main() {
+    result1 := validator.IsPassport("P123456789", "CN")
+    result2 := validator.IsPassport("123456789", "US")
+    result3 := validator.IsPassport("AB1234567", "RU")
+    result4 := validator.IsPassport("123456789", "CN")
+
+    fmt.Println(result1)
+    fmt.Println(result2)
+    fmt.Println(result3)
+    fmt.Println(result4)
+
+    // Output:
+    // true
+    // true
+    // true
+    // false
+}
+```
+
+### <span id="IsChineseHMPassport">IsChineseHMPassport</span>
+
+<p>Mainland travel permit for Hong Kong, Macao validation (using regex). </p>
+
+<b>Signature:</b>
+
+```go
+func IsChineseHMPassport(hmPassport string) bool
+```
+
+<b>Example:<span style="float:right;display:inline-block">[Run](https://go.dev/play/p/todo)</span></b>
+
+```go
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/validator"
+)
+
+func main() {
+    result1 := validator.IsChineseHMPassport("C12345678")
+    result2 := validator.IsChineseHMPassport("C00000000")
+    result3 := validator.IsChineseHMPassport("M12345678")
+    result4 := validator.IsChineseHMPassport("c12345678")
+    result5 := validator.IsChineseHMPassport("C1234567")
+
+    fmt.Println(result1)
+    fmt.Println(result2)
+    fmt.Println(result3)
+    fmt.Println(result4)
+    fmt.Println(result5)
+
+    // Output:
+    // true
+    // true
+    // true
+    // false
+    // false
+}
+```
--- a/docs/package-lock.json
+++ b/docs/package-lock.json
--- a/enum/enum.go
+++ b/enum/enum.go
@@ -26,6 +26,7 @@ type Item[T comparable] struct {
 	name  string
 }

+// NewItem creates a new enum item.
 func NewItem[T comparable](value T, name string) *Item[T] {
 	return &Item[T]{value: value, name: name}
 }
@@ -37,7 +38,7 @@ type Pair[T comparable] struct {
 }

 // NewItemsFromPairs creates enum items from a slice of Pair structs.
-func NewItems[T comparable](pairs ...Pair[T]) []*Item[T] {
+func NewItemsFromPairs[T comparable](pairs ...Pair[T]) []*Item[T] {
 	if len(pairs) == 0 {
 		return []*Item[T]{}
 	}
@@ -50,37 +51,40 @@ func NewItems[T comparable](pairs ...Pair[T]) []*Item[T] {
 	return items
 }

-func (e *Item[T]) Value() T {
-	return e.value
+// Value returns the value of the enum item.
+func (it *Item[T]) Value() T {
+	return it.value
 }

-func (e *Item[T]) Name() string {
-	return e.name
+// Name returns the name of the enum item.
+func (it *Item[T]) Name() string {
+	return it.name
 }

-func (e *Item[T]) String() string {
-	return e.name
+// String returns the string representation of the enum item.
+func (it *Item[T]) String() string {
+	return it.name
 }

 // Valid checks if the enum item is valid. If a custom check function is provided, it will be used to validate the value.
-func (e *Item[T]) Valid(checker ...func(T) bool) bool {
+func (it *Item[T]) Valid(checker ...func(T) bool) bool {
 	if len(checker) > 0 {
-		return checker[0](e.value) && e.name != ""
+		return checker[0](it.value) && it.name != ""
 	}
 	var zero T
-	return e.value != zero && e.name != ""
+	return it.value != zero && it.name != ""
 }

 // MarshalJSON implements the json.Marshaler interface.
-func (e *Item[T]) MarshalJSON() ([]byte, error) {
+func (it *Item[T]) MarshalJSON() ([]byte, error) {
 	return json.Marshal(map[string]any{
-		"value": e.value,
-		"name":  e.name,
+		"value": it.value,
+		"name":  it.name,
 	})
 }

 // UnmarshalJSON implements the json.Unmarshaler interface.
-func (e *Item[T]) UnmarshalJSON(data []byte) error {
+func (it *Item[T]) UnmarshalJSON(data []byte) error {
 	type alias struct {
 		Value any    `json:"value"`
 		Name  string `json:"name"`
@@ -99,48 +103,47 @@ func (e *Item[T]) UnmarshalJSON(data []byte) error {
 			return fmt.Errorf("invalid type for value, want int family")
 		}
 		converted := reflect.ValueOf(int64(val)).Convert(rv)
-		e.value = converted.Interface().(T)
+		it.value = converted.Interface().(T)
 	case reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64:
 		val, ok := temp.Value.(float64)
 		if !ok {
 			return fmt.Errorf("invalid type for value, want uint family")
 		}
 		converted := reflect.ValueOf(uint64(val)).Convert(rv)
-		e.value = converted.Interface().(T)
+		it.value = converted.Interface().(T)
 	case reflect.Float32, reflect.Float64:
 		val, ok := temp.Value.(float64)
 		if !ok {
 			return fmt.Errorf("invalid type for value, want float family")
 		}
 		converted := reflect.ValueOf(val).Convert(rv)
-		e.value = converted.Interface().(T)
+		it.value = converted.Interface().(T)
 	case reflect.String:
 		val, ok := temp.Value.(string)
 		if !ok {
 			return fmt.Errorf("invalid type for value, want string")
 		}
-		e.value = any(val).(T)
+		it.value = any(val).(T)
 	case reflect.Bool:
 		val, ok := temp.Value.(bool)
 		if !ok {
 			return fmt.Errorf("invalid type for value, want bool")
 		}
-		e.value = any(val).(T)
+		it.value = any(val).(T)
 	default:
-		// 枚举类型底层通常是 int，可以尝试 float64->int64->底层类型
 		val, ok := temp.Value.(float64)
 		if ok {
 			converted := reflect.ValueOf(int64(val)).Convert(rv)
-			e.value = converted.Interface().(T)
+			it.value = converted.Interface().(T)
 		} else {
 			val2, ok2 := temp.Value.(T)
 			if !ok2 {
 				return fmt.Errorf("invalid type for value")
 			}
-			e.value = val2
+			it.value = val2
 		}
 	}
-	e.name = temp.Name
+	it.name = temp.Name
 	return nil
 }

@@ -152,6 +155,7 @@ type Registry[T comparable] struct {
 	items  []*Item[T]
 }

+// NewRegistry creates a new enum registry.
 func NewRegistry[T comparable](items ...*Item[T]) *Registry[T] {
 	r := &Registry[T]{
 		values: make(map[T]*Item[T]),
@@ -250,24 +254,6 @@ func (r *Registry[T]) Contains(value T) bool {
 	return ok
 }

-// Validate checks if the given value is a valid enum item in the registry.
-func (r *Registry[T]) Validate(value T) error {
-	if !r.Contains(value) {
-		return fmt.Errorf("invalid enum value: %v", value)
-	}
-	return nil
-}
-
-// ValidateAll checks if all given values are valid enum items in the registry.
-func (r *Registry[T]) ValidateAll(values ...T) error {
-	for _, value := range values {
-		if err := r.Validate(value); err != nil {
-			return err
-		}
-	}
-	return nil
-}
-
 // Size returns the number of enum items in the registry.
 func (r *Registry[T]) Size() int {
 	r.mu.RLock()
--- a/enum/enum_example_test.go
+++ b/enum/enum_example_test.go
@@ -3,7 +3,19 @@ package enum
 import "fmt"

 func ExampleNewItem() {
-	items := NewItems(
+	item1 := NewItem(Active, "Active")
+	item2 := NewItem(Inactive, "Inactive")
+
+	fmt.Println(item1.Name(), item1.Value())
+	fmt.Println(item2.Name(), item2.Value())
+
+	// Output:
+	// Active 1
+	// Inactive 2
+}
+
+func ExampleNewItemsFromPairs() {
+	items := NewItemsFromPairs(
 		Pair[Status]{Value: Active, Name: "Active"},
 		Pair[Status]{Value: Inactive, Name: "Inactive"},
 	)
@@ -114,41 +126,15 @@ func ExampleRegistry_Items() {

 func ExampleRegistry_Contains() {
 	registry := NewRegistry[Status]()
-	item1 := NewItem(Active, "Active")
-	registry.Add(item1)
+	item := NewItem(Active, "Active")
+	registry.Add(item)

-	fmt.Println("Contains Active:", registry.Contains(Active))
-	fmt.Println("Contains Inactive:", registry.Contains(Inactive))
-}
-
-func ExampleRegistry_Validate() {
-	registry := NewRegistry[Status]()
-	item1 := NewItem(Active, "Active")
-	item2 := NewItem(Inactive, "Inactive")
-	registry.Add(item1, item2)
-
-	fmt.Println("Validate Active:", registry.Validate(Active))
-	fmt.Println("Validate Inactive:", registry.Validate(Inactive))
-	fmt.Println("Validate Unknown:", registry.Validate(Unknown))
+	fmt.Println(registry.Contains(Active))
+	fmt.Println(registry.Contains(Inactive))

 	// Output:
-	// Validate Active: <nil>
-	// Validate Inactive: <nil>
-	// Validate Unknown: invalid enum value: 0
-}
-
-func ExampleRegistry_ValidateAll() {
-	registry := NewRegistry[Status]()
-	item1 := NewItem(Active, "Active")
-	item2 := NewItem(Inactive, "Inactive")
-	registry.Add(item1, item2)
-
-	fmt.Println("ValidateAll Active, Inactive:", registry.ValidateAll(Active, Inactive))
-	fmt.Println("ValidateAll Active, Unknown:", registry.ValidateAll(Active, Unknown))
-
-	// Output:
-	// ValidateAll Active, Inactive: <nil>
-	// ValidateAll Active, Unknown: invalid enum value: 0
+	// true
+	// false
 }

 func ExampleRegistry_Size() {
--- a/enum/enum_test.go
+++ b/enum/enum_test.go
@@ -17,11 +17,11 @@ const (
 	Inactive
 )

-func TestNewItem(t *testing.T) {
+func TestNewItemsFromPairs(t *testing.T) {
 	t.Parallel()
-	assert := internal.NewAssert(t, "TestNewItem")
+	assert := internal.NewAssert(t, "TestNewItemsFromPairs")

-	items := NewItems(
+	items := NewItemsFromPairs(
 		Pair[Status]{Value: Active, Name: "Active"},
 		Pair[Status]{Value: Inactive, Name: "Inactive"},
 	)
@@ -128,40 +128,6 @@ func TestRegistry_Contains(t *testing.T) {
 	assert.Equal(false, registry.Contains(Inactive))
 }

-func TestRegistry_Validate(t *testing.T) {
-	t.Parallel()
-	assert := internal.NewAssert(t, "TestRegistry_Validate")
-
-	registry := NewRegistry[Status]()
-	item1 := NewItem(Active, "Active")
-	item2 := NewItem(Inactive, "Inactive")
-	registry.Add(item1, item2)
-
-	err := registry.Validate(Active)
-	assert.IsNil(err)
-	err = registry.Validate(Inactive)
-	assert.IsNil(err)
-
-	err = registry.Validate(Unknown)
-	assert.IsNotNil(err)
-}
-
-func TestRegistry_ValidateAll(t *testing.T) {
-	t.Parallel()
-	assert := internal.NewAssert(t, "TestRegistry_ValidateAll")
-
-	registry := NewRegistry[Status]()
-	item1 := NewItem(Active, "Active")
-	item2 := NewItem(Inactive, "Inactive")
-	registry.Add(item1, item2)
-
-	err := registry.ValidateAll(Active, Inactive)
-	assert.IsNil(err)
-
-	err = registry.ValidateAll(Active, Unknown)
-	assert.IsNotNil(err)
-}
-
 func TestRegistry_Range(t *testing.T) {
 	t.Parallel()
 	assert := internal.NewAssert(t, "TestRegistry_Range")
--- a/maputil/map.go
+++ b/maputil/map.go
@@ -683,6 +683,7 @@ func FindValuesBy[K comparable, V any](m map[K]V, predicate func(key K, value V)
 }

 // ToMarkdownTable converts a slice of maps to a Markdown table.
+// Play: ttps://go.dev/play/p/todo
 func ToMarkdownTable(data []map[string]interface{}, headerMap map[string]string, columnOrder []string) string {
 	if len(data) == 0 {
 		return "| |\n|---|\n"
--- a/structs/field.go
+++ b/structs/field.go
@@ -26,26 +26,31 @@ func newField(v reflect.Value, f reflect.StructField, tagName string) *Field {
 }

 // Tag returns the value that the key in the tag string.
+// Play: https://go.dev/play/p/DVrx5HvvUJr
 func (f *Field) Tag() *Tag {
 	return f.tag
 }

 // Value returns the underlying value of the field.
+// Play: https://go.dev/play/p/qufYEU2o4Oi
 func (f *Field) Value() any {
 	return f.rvalue.Interface()
 }

 // IsEmbedded returns true if the given field is an embedded field.
+// Play: https://go.dev/play/p/wV2PrbYm3Ec
 func (f *Field) IsEmbedded() bool {
 	return len(f.field.Index) > 1
 }

 // IsExported returns true if the given field is exported.
+// Play: https://go.dev/play/p/csK4AXYaNbJ
 func (f *Field) IsExported() bool {
 	return f.field.IsExported()
 }

 // IsZero returns true if the given field is zero value.
+// Play: https://go.dev/play/p/RzqpGISf87r
 func (f *Field) IsZero() bool {
 	z := reflect.Zero(f.rvalue.Type()).Interface()
 	v := f.Value()
@@ -63,22 +68,26 @@ func (f *Field) IsNil() bool {
 }

 // Name returns the name of the given field
+// Play: https://go.dev/play/p/zfIGlqsatee
 func (f *Field) Name() string {
 	return f.field.Name
 }

 // Kind returns the field's kind
+// Play: https://go.dev/play/p/wg4NlcUNG5o
 func (f *Field) Kind() reflect.Kind {
 	return f.rvalue.Kind()
 }

 // IsSlice check if a struct field type is slice or not
+// Play: https://go.dev/play/p/MKz4CgBIUrU
 func (f *Field) IsSlice() bool {
 	k := f.rvalue.Kind()
 	return k == reflect.Slice
 }

 // IsTargetType check if a struct field type is target type or not
+// Play: https://go.dev/play/p/Ig75P-agN39
 func (f *Field) IsTargetType(targetType reflect.Kind) bool {
 	return f.rvalue.Kind() == targetType
 }
--- a/structs/struct.go
+++ b/structs/struct.go
@@ -20,6 +20,7 @@ type Struct struct {
 }

 // New returns a new *Struct
+// Play: https://go.dev/play/p/O29l8kk-Z17
 func New(value any, tagName ...string) *Struct {
 	value = pointer.ExtractPointer(value)
 	v := reflect.ValueOf(value)
@@ -60,6 +61,7 @@ func New(value any, tagName ...string) *Struct {
 //	 	Name string `json:"myName"`
 //
 // ToMap convert the exported fields of a struct to map.
+// Play: https://go.dev/play/p/qQbLySBgerZ
 func (s *Struct) ToMap() (map[string]any, error) {
 	if !s.IsStruct() {
 		return nil, fmt.Errorf("invalid struct %v", s)
@@ -87,6 +89,7 @@ func (s *Struct) ToMap() (map[string]any, error) {
 }

 // Fields returns all the struct fields within a slice
+// Play: https://go.dev/play/p/w3Kk_CyVY7D
 func (s *Struct) Fields() []*Field {
 	fieldNum := s.rvalue.NumField()
 	fields := make([]*Field, 0, fieldNum)
@@ -100,6 +103,7 @@ func (s *Struct) Fields() []*Field {
 }

 // Field returns a Field if the given field name was found
+// Play: https://go.dev/play/p/KocZMSYarza
 func (s *Struct) Field(name string) (*Field, bool) {
 	f, ok := s.rtype.FieldByName(name)
 	if !ok {
@@ -109,6 +113,7 @@ func (s *Struct) Field(name string) (*Field, bool) {
 }

 // IsStruct returns true if the given rvalue is a struct
+// Play: https://go.dev/play/p/bU2FSdkbK1C
 func (s *Struct) IsStruct() bool {
 	k := s.rvalue.Kind()
 	if k == reflect.Invalid {
@@ -119,11 +124,13 @@ func (s *Struct) IsStruct() bool {

 // ToMap convert struct to map, only convert exported struct field
 // map key is specified same as struct field tag `json` value.
+// Play: https://go.dev/play/p/qQbLySBgerZ
 func ToMap(v any) (map[string]any, error) {
 	return New(v).ToMap()
 }

 // TypeName return struct type name
+// Play: https://go.dev/play/p/todo
 func (s *Struct) TypeName() string {
 	return s.rtype.Name()
 }
Author	SHA1	Message	Date
dudaodong	2a2e1ca551	doc: add enum and update overview index	2025-10-31 14:57:54 +08:00
dudaodong	e1821eed2c	doc: add docment for enum package	2025-10-31 14:48:32 +08:00
dudaodong	62f0a96d91	doc: add docment for enum package	2025-10-31 14:48:22 +08:00
dudaodong	cbdc3971dd	doc: add docment for new or fixed function	2025-10-31 13:37:41 +08:00