validators

Documentation

Index

• Constants
• func AbsoluteFilePathValidator() validator.String
• func FileID() validator.String
• func HardwareMappingDeviceIDValidator() validator.String
• func KeyboardLayoutValidator() validator.String
• func LanguageValidator() validator.String
• func NewParseValidator[T any](parseFunction func(string) (T, error), description string) validator.String
• func NonEmptyString() validator.String

Constants

const (
	// HardwareMappingDeviceIDValidatorErrMessage is the error message when the validation fails.
	HardwareMappingDeviceIDValidatorErrMessage = `value must be a valid hardware mapping device ID, e.g. "8086:5916"`
)

Functions

func AbsoluteFilePathValidator

func AbsoluteFilePathValidator() validator.String

AbsoluteFilePathValidator validates that a string is an absolute file path.

func FileID

func FileID() validator.String

FileID returns a validator that checks if a string is a valid file ID.

func HardwareMappingDeviceIDValidator

func HardwareMappingDeviceIDValidator() validator.String

HardwareMappingDeviceIDValidator validates a hardware mapping device ID.

func KeyboardLayoutValidator

func KeyboardLayoutValidator() validator.String

KeyboardLayoutValidator returns a new validator for keyboard layouts.

func LanguageValidator

func LanguageValidator() validator.String

LanguageValidator returns a new validator for language codes.

func NewParseValidator

func NewParseValidator[T any](parseFunction func(string) (T, error), description string) validator.String

NewParseValidator creates a validator which uses a parsing function to validate a string. The function is expected to return a value of type `T` and an error. If the error is non-nil, the validator will fail. The `description` argument should contain a description of the validator's effect.

func NonEmptyString

func NonEmptyString() validator.String

NonEmptyString returns a new validator to ensure a non-empty string.