API リファレンス

公開サーフェスのコンパクトなリファレンス。文章スタイルのドキュメ ントは ガイド を参照。

非公開ヘルパーを含む完全な Go API は pkg.go.dev/github.com/wuhan005/govalid を参照してください。

トップレベル

// v をバリデートし、失敗のリストと全体の ok フラグを返す。
func Check(v interface{}, lang ...language.Tag) (errs []*ErrContext, ok bool)

// 指定ロケール（省略時はデフォルト）にテンプレートをマージ。
func SetMessageTemplates(templates map[string]string, lang ...language.Tag)

変数

// タグ名——他の名前空間が必要なら起動時に変更します。
var RulesField   = "valid"
var LabelField   = "label"
var MessageField = "msg"

// {field} / {limit} を含むテンプレートで使われるプレースホルダー。
var FieldNamePlaceholder  = "{field}"
var FieldLimitPlaceholder = "{limit}"

// 登録済みチェッカー。起動時に書き換える前提。
var Checkers map[string]CheckFunc

// 携帯番号ルールを差し替えるために MobilePattern が公開されています。
var MobilePattern *regexp.Regexp

型

• CheckFunc —— チェッカー関数のシグネチャ。
• CheckerContext —— 各チェッカーが受け取る もの。
• ErrContext —— 失敗が返すもの。

ヘルパー

func NewErrorContext(c CheckerContext) *ErrContext
func MakeUserDefinedError(msg string)  *ErrContext
func MakeValueTypeError(c CheckerContext) *ErrContext
func MakeCheckerParamError(c CheckerContext) *ErrContext
func MakeCheckerNotFoundError(c CheckerContext) *ErrContext
func MakeFieldNotFoundError(c CheckerContext) *ErrContext