is

Documentation

Overview

Package is provides format validation rules for common string patterns.

Each function returns a value satisfying edict.Rule and edict.Coder. Use with Apply():

v.Field("email").Apply(is.Email())
v.Field("site").Apply(is.URL())

Index

• type Rule
  • func Alpha() Rule
  • func AlphaNumeric() Rule
  • func Email() Rule
  • func HexColor() Rule
  • func IPv4() Rule
  • func IPv6() Rule
  • func Numeric() Rule
  • func Semver() Rule
  • func Slug() Rule
  • func URL() Rule
  • func UUID() Rule

Types

type Rule

type Rule interface {
	Validate(value any) error
}

Rule is the interface satisfied by all format validators in this package. It matches edict.Rule via structural typing.

func Alpha

func Alpha() Rule

Alpha returns a Rule that validates the value contains only ASCII letters.

func AlphaNumeric

func AlphaNumeric() Rule

AlphaNumeric returns a Rule that validates the value contains only ASCII letters and digits.

func Email

func Email() Rule

Email returns a Rule that validates email address format.

func HexColor

func HexColor() Rule

HexColor returns a Rule that validates hex color format (#RGB or #RRGGBB).

func IPv4

func IPv4() Rule

IPv4 returns a Rule that validates IPv4 address format.

func IPv6

func IPv6() Rule

IPv6 returns a Rule that validates IPv6 address format.

func Numeric

func Numeric() Rule

Numeric returns a Rule that validates the value contains only ASCII digits.

func Semver

func Semver() Rule

Semver returns a Rule that validates semantic versioning format (X.Y.Z with optional v prefix).

func Slug

func Slug() Rule

Slug returns a Rule that validates URL slug format (lowercase alphanumeric with hyphens).

func URL

func URL() Rule

URL returns a Rule that validates URL format (requires scheme and host).

func UUID

func UUID() Rule

UUID returns a Rule that validates UUID format (8-4-4-4-12 hex).