stringvalidator

package
v1.15.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 13, 2025 License: MPL-2.0 Imports: 14 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Cases added in v1.12.0 

func Cases(casesTypes []CasesValidatorType) validator.String

Cases returns a new string validator that checks if the string matches any of the specified case types.

Parameters:

  • casesTypes: A slice of CasesValidatorType that specifies the types of cases to validate against.

Returns:

  • validator.String: A string validator that validates the string against the specified case types.

func HTTPCode added in v1.15.0 

func HTTPCode(settings HTTPCodeParams) validator.String

HTTPCode validates that a string represents a valid HTTP status code.

Parameters:

  • settings: HTTPCodeParams containing the configuration for the validator.

Returns:

  • validator.String: A validator that checks if the string is a valid HTTP status code.

func IsIP 

func IsIP() validator.String

IsIP returns a validator which ensures that the configured attribute value is a valid IP address with net.ParseIP package.

Null (unconfigured) and unknown (known after apply) values are skipped.

func IsMacAddress 

func IsMacAddress() validator.String

IsMacAddress

returns a validator which ensures that the configured attribute value is a valid MacAddress.

Null (unconfigured) and unknown (known after apply) values are skipped.

func IsNetmask 

func IsNetmask() validator.String

IsNetmask

returns a validator which ensures that the configured attribute value is a valid Netmask.

Null (unconfigured) and unknown (known after apply) values are skipped.

func IsNetwork 

func IsNetwork(networkTypes []NetworkValidatorType, comparatorOR bool) validator.String

IsNetwork returns a validator that validates the string value is a valid network.

Parameters:

  • networkTypes : The network types to validate.
  • comparatorOR : If true, the value must be at least one of the network types.

func IsURN 

func IsURN() validator.String

IsURN returns a validator which ensures that the configured attribute value is a valid URN.

Null (unconfigured) and unknown (known after apply) values are skipped.

func IsUUID 

func IsUUID() validator.String

IsUUID returns a validator which ensures that the configured attribute value is a valid (v4) UUID.

Null (unconfigured) and unknown (known after apply) values are skipped.

func Not 

func Not(valueValidator validator.String) validator.String

Not returns a validator which ensures that the validators passed as arguments are not met.

func NullIfAttributeIsOneOf 

func NullIfAttributeIsOneOf(path path.Expression, exceptedValue []attr.Value) validator.String

NullIfAttributeIsOneOf checks if the path.Path attribute contains one of the exceptedValue attr.Value.

func NullIfAttributeIsSet 

func NullIfAttributeIsSet(path path.Expression) validator.String

NullIfAttributeIsSet checks if the path.Path attribute contains one of the exceptedValue attr.Value.

func OneOfWithDescription 

func OneOfWithDescription(values ...OneOfWithDescriptionValues) validator.String

OneOfWithDescription checks that the String held in the attribute is one of the given `values`. The description of the value is used to generate advanced Description and MarkdownDescription messages.

func OneOfWithDescriptionIfAttributeIsOneOf added in v1.10.0 

func OneOfWithDescriptionIfAttributeIsOneOf(path path.Expression, exceptedValue []attr.Value, values ...OneOfWithDescriptionIfAttributeIsOneOfValues) validator.String

OneOfWithDescriptionIfAttributeIsOneOf checks that the String value is one of the expected values if the attribute is one of the exceptedValue. The description of the value is used to generate advanced Description and MarkdownDescription messages.

func PrefixContains 

func PrefixContains(prefix string) validator.String

PrefixContainsValidator is a validator which ensures that the configured attribute value contains the specified prefix.

Null (unconfigured) and unknown (known after apply) values are skipped.

func RequireIfAttributeIsOneOf 

func RequireIfAttributeIsOneOf(path path.Expression, exceptedValue []attr.Value) validator.String

RequireIfAttributeIsOneOf checks if the path.Path attribute contains one of the exceptedValue attr.Value.

func RequireIfAttributeIsSet 

func RequireIfAttributeIsSet(path path.Expression) validator.String

RequireIfAttributeIsSet checks if the path.Path attribute is set.

Types

type CasesValidatorType added in v1.12.0 

type CasesValidatorType string
const (
	CasesDisallowUpper  CasesValidatorType = "disallow_upper"
	CasesDisallowNumber CasesValidatorType = "disallow_number"
	CasesDisallowSpace  CasesValidatorType = "disallow_space"
	CasesDisallowLower  CasesValidatorType = "disallow_lower"
)

type HTTPCodeParams added in v1.15.0 

type HTTPCodeParams struct {
	Allow1xx bool
	Allow2xx bool
	Allow3xx bool
	Allow4xx bool
	Allow5xx bool
}

type NetworkValidatorType 

type NetworkValidatorType string
const (
	IPV4            NetworkValidatorType = "ipv4"
	IPV4WithCIDR    NetworkValidatorType = "ipv4_with_cidr"
	IPV4WithNetmask NetworkValidatorType = "ipv4_with_netmask"
	IPV4Range       NetworkValidatorType = "ipv4_range"
	RFC1918         NetworkValidatorType = "rfc1918"

	TCPUDPPortRange NetworkValidatorType = "tcpudp_port_range"
	TCPUDPPort      NetworkValidatorType = "tcpudp_port"
)

type OneOfWithDescriptionIfAttributeIsOneOfValues added in v1.10.0 

type OneOfWithDescriptionIfAttributeIsOneOfValues struct {
	Value       string
	Description string
}

type OneOfWithDescriptionValues 

type OneOfWithDescriptionValues struct {
	Value       string
	Description string
}

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.