Documentation
¶
Index ¶
- Variables
- func NewMapDataProvider[T any](m map[string]T) p.DataProviderdeprecated
- func TestFunc(errCode zconst.ZogErrCode, validateFunc p.TestFunc) p.Test
- type BoolSchema
- func (v *BoolSchema) Catch(val bool) *BoolSchema
- func (v *BoolSchema) Default(val bool) *BoolSchema
- func (v *BoolSchema) False() *BoolSchema
- func (v *BoolSchema) Optional() *BoolSchema
- func (v *BoolSchema) Parse(data any, dest *bool, options ...ParsingOption) p.ZogErrList
- func (v *BoolSchema) PostTransform(transform p.PostTransform) *BoolSchema
- func (v *BoolSchema) PreTransform(transform p.PreTransform) *BoolSchema
- func (v *BoolSchema) Required(options ...TestOption) *BoolSchema
- func (v *BoolSchema) True() *BoolSchema
- func (v *BoolSchema) Validate(val *bool, options ...ParsingOption) p.ZogErrList
- type ComplexZogSchema
- type Ctx
- type NumberSchema
- func (v *NumberSchema[T]) Catch(val T) *NumberSchema[T]
- func (v *NumberSchema[T]) Default(val T) *NumberSchema[T]
- func (v *NumberSchema[T]) EQ(n T, options ...TestOption) *NumberSchema[T]
- func (v *NumberSchema[T]) GT(n T, options ...TestOption) *NumberSchema[T]
- func (v *NumberSchema[T]) GTE(n T, options ...TestOption) *NumberSchema[T]
- func (v *NumberSchema[T]) LT(n T, options ...TestOption) *NumberSchema[T]
- func (v *NumberSchema[T]) LTE(n T, options ...TestOption) *NumberSchema[T]
- func (v *NumberSchema[T]) OneOf(enum []T, options ...TestOption) *NumberSchema[T]
- func (v *NumberSchema[T]) Optional() *NumberSchema[T]
- func (v *NumberSchema[T]) Parse(data any, dest *T, options ...ParsingOption) p.ZogErrList
- func (v *NumberSchema[T]) PostTransform(transform p.PostTransform) *NumberSchema[T]
- func (v *NumberSchema[T]) PreTransform(transform p.PreTransform) *NumberSchema[T]
- func (v *NumberSchema[T]) Required(options ...TestOption) *NumberSchema[T]
- func (v *NumberSchema[T]) Test(t p.Test, opts ...TestOption) *NumberSchema[T]
- func (v *NumberSchema[T]) Validate(data *T) p.ZogErrList
- type Numeric
- type ParseCtxdeprecated
- type ParsingOption
- type PointerSchema
- type PrimitiveZogSchema
- type Schema
- type SchemaOption
- type SliceSchema
- func (v *SliceSchema) Contains(value any, options ...TestOption) *SliceSchema
- func (v *SliceSchema) Default(val any) *SliceSchema
- func (v *SliceSchema) Len(n int, options ...TestOption) *SliceSchema
- func (v *SliceSchema) Max(n int, options ...TestOption) *SliceSchema
- func (v *SliceSchema) Min(n int, options ...TestOption) *SliceSchema
- func (v *SliceSchema) Optional() *SliceSchema
- func (v *SliceSchema) Parse(data any, dest any, options ...ParsingOption) p.ZogErrMap
- func (v *SliceSchema) PostTransform(transform p.PostTransform) *SliceSchema
- func (v *SliceSchema) PreTransform(transform p.PreTransform) *SliceSchema
- func (v *SliceSchema) Required(options ...TestOption) *SliceSchema
- func (v *SliceSchema) Test(t p.Test, opts ...TestOption) *SliceSchema
- func (v *SliceSchema) Validate(data any) p.ZogErrMap
- type StringSchema
- func (v *StringSchema) Catch(val string) *StringSchema
- func (v *StringSchema) Contains(sub string, options ...TestOption) *StringSchema
- func (v *StringSchema) ContainsDigit(options ...TestOption) *StringSchema
- func (v *StringSchema) ContainsSpecial(options ...TestOption) *StringSchema
- func (v *StringSchema) ContainsUpper(options ...TestOption) *StringSchema
- func (v *StringSchema) Default(val string) *StringSchema
- func (v *StringSchema) Email(options ...TestOption) *StringSchema
- func (v *StringSchema) HasPrefix(s string, options ...TestOption) *StringSchema
- func (v *StringSchema) HasSuffix(s string, options ...TestOption) *StringSchema
- func (v *StringSchema) Len(n int, options ...TestOption) *StringSchema
- func (v *StringSchema) Match(regex *regexp.Regexp, options ...TestOption) *StringSchema
- func (v *StringSchema) Max(n int, options ...TestOption) *StringSchema
- func (v *StringSchema) Min(n int, options ...TestOption) *StringSchema
- func (v *StringSchema) OneOf(enum []string, options ...TestOption) *StringSchema
- func (v *StringSchema) Optional() *StringSchema
- func (v *StringSchema) Parse(data any, dest *string, options ...ParsingOption) p.ZogErrList
- func (v *StringSchema) PostTransform(transform p.PostTransform) *StringSchema
- func (v *StringSchema) PreTransform(transform p.PreTransform) *StringSchema
- func (v *StringSchema) Required(options ...TestOption) *StringSchema
- func (v *StringSchema) Test(t p.Test, opts ...TestOption) *StringSchema
- func (v *StringSchema) Trim() *StringSchema
- func (v *StringSchema) URL(options ...TestOption) *StringSchema
- func (v *StringSchema) UUID(options ...TestOption) *StringSchema
- func (v *StringSchema) Validate(data *string) p.ZogErrList
- type StructSchema
- func (v *StructSchema) Extend(schema Schema) *StructSchema
- func (v *StructSchema) Merge(other *StructSchema, others ...*StructSchema) *StructSchema
- func (v *StructSchema) Omit(vals ...any) *StructSchema
- func (v *StructSchema) Optional() *StructSchema
- func (v *StructSchema) Parse(data any, destPtr any, options ...ParsingOption) p.ZogErrMap
- func (v *StructSchema) Pick(picks ...any) *StructSchema
- func (v *StructSchema) PostTransform(transform p.PostTransform) *StructSchema
- func (v *StructSchema) PreTransform(transform p.PreTransform) *StructSchema
- func (v *StructSchema) Required(options ...TestOption) *StructSchema
- func (v *StructSchema) Test(t p.Test, opts ...TestOption) *StructSchema
- func (v *StructSchema) Validate(data any) p.ZogErrMap
- type Test
- type TestOption
- type TimeFunc
- type TimeSchema
- func (v *TimeSchema) After(t time.Time, opts ...TestOption) *TimeSchema
- func (v *TimeSchema) Before(t time.Time, opts ...TestOption) *TimeSchema
- func (v *TimeSchema) Catch(val time.Time) *TimeSchema
- func (v *TimeSchema) Default(val time.Time) *TimeSchema
- func (v *TimeSchema) EQ(t time.Time, opts ...TestOption) *TimeSchema
- func (v *TimeSchema) Optional() *TimeSchema
- func (v *TimeSchema) Parse(data any, dest *time.Time, options ...ParsingOption) p.ZogErrList
- func (v *TimeSchema) PostTransform(transform p.PostTransform) *TimeSchema
- func (v *TimeSchema) PreTransform(transform p.PreTransform) *TimeSchema
- func (v *TimeSchema) Required(options ...TestOption) *TimeSchema
- func (v *TimeSchema) Test(t p.Test, opts ...TestOption) *TimeSchema
- func (v *TimeSchema) Validate(data *time.Time) p.ZogErrList
- type ZogErrList
- type ZogErrMap
- type ZogError
- type ZogSchema
Constants ¶
This section is empty.
Variables ¶
var Errors = errHelpers{}
Helper struct for dealing with zog errors. Beware this API may change
Functions ¶
func NewMapDataProvider
deprecated
func NewMapDataProvider[T any](m map[string]T) p.DataProvider
Deprecated: This will be removed in the future. You should just pass your map[string]T to the schema.Parse() function directly without using this: old: schema.Parse(z.NewMapDataProvider(m), &dest) new: schema.Parse(m, &dest)
Types ¶
type BoolSchema ¶ added in v0.14.1
type BoolSchema struct {
// contains filtered or unexported fields
}
func (*BoolSchema) Catch ¶ added in v0.14.1
func (v *BoolSchema) Catch(val bool) *BoolSchema
sets the catch value (i.e the value to use if the validation fails)
func (*BoolSchema) Default ¶ added in v0.14.1
func (v *BoolSchema) Default(val bool) *BoolSchema
sets the default value
func (*BoolSchema) False ¶ added in v0.14.1
func (v *BoolSchema) False() *BoolSchema
func (*BoolSchema) Optional ¶ added in v0.14.1
func (v *BoolSchema) Optional() *BoolSchema
marks field as optional
func (*BoolSchema) Parse ¶ added in v0.14.1
func (v *BoolSchema) Parse(data any, dest *bool, options ...ParsingOption) p.ZogErrList
Parse data into destination pointer
func (*BoolSchema) PostTransform ¶ added in v0.14.1
func (v *BoolSchema) PostTransform(transform p.PostTransform) *BoolSchema
Adds posttransform function to schema
func (*BoolSchema) PreTransform ¶ added in v0.14.1
func (v *BoolSchema) PreTransform(transform p.PreTransform) *BoolSchema
Adds pretransform function to schema
func (*BoolSchema) Required ¶ added in v0.14.1
func (v *BoolSchema) Required(options ...TestOption) *BoolSchema
! MODIFIERS marks field as required
func (*BoolSchema) True ¶ added in v0.14.1
func (v *BoolSchema) True() *BoolSchema
func (*BoolSchema) Validate ¶ added in v0.15.0
func (v *BoolSchema) Validate(val *bool, options ...ParsingOption) p.ZogErrList
Validate data against schema
type ComplexZogSchema ¶ added in v0.14.1
type ComplexZogSchema interface {
ZogSchema
Parse(val any, dest any, options ...ParsingOption) ZogErrMap
}
This is a common interface for all complex schemas (i.e structs, slices, pointers...) You can use this to pass any complex schema around
type Ctx ¶ added in v0.15.0
This is the context that is passed through an entire execution of `schema.Parse()` or `schema.Validate()`. You can use it to pass a key/value for a specific execution. More about context in the [docs](https://zog.dev/context)
type NumberSchema ¶ added in v0.14.1
type NumberSchema[T Numeric] struct { // contains filtered or unexported fields }
func (*NumberSchema[T]) Catch ¶ added in v0.14.1
func (v *NumberSchema[T]) Catch(val T) *NumberSchema[T]
sets the catch value (i.e the value to use if the validation fails)
func (*NumberSchema[T]) Default ¶ added in v0.14.1
func (v *NumberSchema[T]) Default(val T) *NumberSchema[T]
sets the default value
func (*NumberSchema[T]) EQ ¶ added in v0.14.1
func (v *NumberSchema[T]) EQ(n T, options ...TestOption) *NumberSchema[T]
checks for equality
func (*NumberSchema[T]) GT ¶ added in v0.14.1
func (v *NumberSchema[T]) GT(n T, options ...TestOption) *NumberSchema[T]
checks for greater
func (*NumberSchema[T]) GTE ¶ added in v0.14.1
func (v *NumberSchema[T]) GTE(n T, options ...TestOption) *NumberSchema[T]
checks for greater or equal
func (*NumberSchema[T]) LT ¶ added in v0.14.1
func (v *NumberSchema[T]) LT(n T, options ...TestOption) *NumberSchema[T]
checks for lesser
func (*NumberSchema[T]) LTE ¶ added in v0.14.1
func (v *NumberSchema[T]) LTE(n T, options ...TestOption) *NumberSchema[T]
checks for lesser or equal
func (*NumberSchema[T]) OneOf ¶ added in v0.14.1
func (v *NumberSchema[T]) OneOf(enum []T, options ...TestOption) *NumberSchema[T]
Check that the value is one of the enum values
func (*NumberSchema[T]) Optional ¶ added in v0.14.1
func (v *NumberSchema[T]) Optional() *NumberSchema[T]
marks field as optional
func (*NumberSchema[T]) Parse ¶ added in v0.14.1
func (v *NumberSchema[T]) Parse(data any, dest *T, options ...ParsingOption) p.ZogErrList
parses the value and stores it in the destination
func (*NumberSchema[T]) PostTransform ¶ added in v0.14.1
func (v *NumberSchema[T]) PostTransform(transform p.PostTransform) *NumberSchema[T]
Adds posttransform function to schema
func (*NumberSchema[T]) PreTransform ¶ added in v0.14.1
func (v *NumberSchema[T]) PreTransform(transform p.PreTransform) *NumberSchema[T]
func (*NumberSchema[T]) Required ¶ added in v0.14.1
func (v *NumberSchema[T]) Required(options ...TestOption) *NumberSchema[T]
marks field as required
func (*NumberSchema[T]) Test ¶ added in v0.14.1
func (v *NumberSchema[T]) Test(t p.Test, opts ...TestOption) *NumberSchema[T]
custom test function call it -> schema.Test(test, options)
func (*NumberSchema[T]) Validate ¶ added in v0.15.0
func (v *NumberSchema[T]) Validate(data *T) p.ZogErrList
Validates a number pointer
type ParsingOption ¶
type ParsingOption = func(p *p.ZogParseCtx)
Options that can be passed to a `schema.Parse()` call
func WithCtxValue ¶
func WithCtxValue(key string, val any) ParsingOption
func WithErrFormatter ¶
func WithErrFormatter(fmter p.ErrFmtFunc) ParsingOption
type PointerSchema ¶ added in v0.14.1
type PointerSchema struct {
// contains filtered or unexported fields
}
func Ptr ¶ added in v0.12.1
func Ptr(schema ZogSchema) *PointerSchema
Ptr creates a pointer ZogSchema
func (*PointerSchema) NotNil ¶ added in v0.14.1
func (v *PointerSchema) NotNil(options ...TestOption) *PointerSchema
func (*PointerSchema) Parse ¶ added in v0.14.1
func (v *PointerSchema) Parse(data any, dest any, options ...ParsingOption) p.ZogErrMap
Parse the data into the destination pointer
func (*PointerSchema) Validate ¶ added in v0.15.0
func (v *PointerSchema) Validate(data any) p.ZogErrList
Validates a pointer pointer
type PrimitiveZogSchema ¶ added in v0.14.1
type PrimitiveZogSchema[T p.ZogPrimitive] interface { ZogSchema Parse(val any, dest *T, options ...ParsingOption) ZogErrList }
This is a common interface for all primitive schemas (i.e strings, numbers, booleans, time.Time...) You can use this to pass any primitive schema around
type SchemaOption ¶ added in v0.12.0
type SchemaOption = func(s ZogSchema)
Options that can be passed to a `schema.New()` call
func WithCoercer ¶ added in v0.12.0
func WithCoercer(c conf.CoercerFunc) SchemaOption
type SliceSchema ¶ added in v0.14.1
type SliceSchema struct {
// contains filtered or unexported fields
}
func Slice ¶
func Slice(schema ZogSchema, opts ...SchemaOption) *SliceSchema
func (*SliceSchema) Contains ¶ added in v0.14.1
func (v *SliceSchema) Contains(value any, options ...TestOption) *SliceSchema
Slice contains a specific value
func (*SliceSchema) Default ¶ added in v0.14.1
func (v *SliceSchema) Default(val any) *SliceSchema
sets the default value
func (*SliceSchema) Len ¶ added in v0.14.1
func (v *SliceSchema) Len(n int, options ...TestOption) *SliceSchema
Exact number of items
func (*SliceSchema) Max ¶ added in v0.14.1
func (v *SliceSchema) Max(n int, options ...TestOption) *SliceSchema
Maximum number of items
func (*SliceSchema) Min ¶ added in v0.14.1
func (v *SliceSchema) Min(n int, options ...TestOption) *SliceSchema
Minimum number of items
func (*SliceSchema) Optional ¶ added in v0.14.1
func (v *SliceSchema) Optional() *SliceSchema
marks field as optional
func (*SliceSchema) Parse ¶ added in v0.14.1
func (v *SliceSchema) Parse(data any, dest any, options ...ParsingOption) p.ZogErrMap
only supports val = slice[any] & dest = &slice[]
func (*SliceSchema) PostTransform ¶ added in v0.14.1
func (v *SliceSchema) PostTransform(transform p.PostTransform) *SliceSchema
Adds posttransform function to schema
func (*SliceSchema) PreTransform ¶ added in v0.14.1
func (v *SliceSchema) PreTransform(transform p.PreTransform) *SliceSchema
Adds pretransform function to schema
func (*SliceSchema) Required ¶ added in v0.14.1
func (v *SliceSchema) Required(options ...TestOption) *SliceSchema
marks field as required
func (*SliceSchema) Test ¶ added in v0.14.1
func (v *SliceSchema) Test(t p.Test, opts ...TestOption) *SliceSchema
custom test function call it -> schema.Test(t z.Test, opts ...TestOption)
type StringSchema ¶ added in v0.14.1
type StringSchema struct {
// contains filtered or unexported fields
}
func (*StringSchema) Catch ¶ added in v0.14.1
func (v *StringSchema) Catch(val string) *StringSchema
sets the catch value (i.e the value to use if the validation fails)
func (*StringSchema) Contains ¶ added in v0.14.1
func (v *StringSchema) Contains(sub string, options ...TestOption) *StringSchema
Test: checks that the value contains the substring
func (*StringSchema) ContainsDigit ¶ added in v0.14.1
func (v *StringSchema) ContainsDigit(options ...TestOption) *StringSchema
Test: checks that the value contains a digit
func (*StringSchema) ContainsSpecial ¶ added in v0.14.1
func (v *StringSchema) ContainsSpecial(options ...TestOption) *StringSchema
Test: checks that the value contains a special character
func (*StringSchema) ContainsUpper ¶ added in v0.14.1
func (v *StringSchema) ContainsUpper(options ...TestOption) *StringSchema
Test: checks that the value contains an uppercase letter
func (*StringSchema) Default ¶ added in v0.14.1
func (v *StringSchema) Default(val string) *StringSchema
sets the default value
func (*StringSchema) Email ¶ added in v0.14.1
func (v *StringSchema) Email(options ...TestOption) *StringSchema
Test: checks that the value is a valid email address
func (*StringSchema) HasPrefix ¶ added in v0.14.1
func (v *StringSchema) HasPrefix(s string, options ...TestOption) *StringSchema
Test: checks that the value has the prefix
func (*StringSchema) HasSuffix ¶ added in v0.14.1
func (v *StringSchema) HasSuffix(s string, options ...TestOption) *StringSchema
Test: checks that the value has the suffix
func (*StringSchema) Len ¶ added in v0.14.1
func (v *StringSchema) Len(n int, options ...TestOption) *StringSchema
Test: checks that the value is exactly n characters long
func (*StringSchema) Match ¶ added in v0.14.1
func (v *StringSchema) Match(regex *regexp.Regexp, options ...TestOption) *StringSchema
Test: checks that value matches to regex
func (*StringSchema) Max ¶ added in v0.14.1
func (v *StringSchema) Max(n int, options ...TestOption) *StringSchema
Test: checks that the value is at most n characters long
func (*StringSchema) Min ¶ added in v0.14.1
func (v *StringSchema) Min(n int, options ...TestOption) *StringSchema
Test: checks that the value is at least n characters long
func (*StringSchema) OneOf ¶ added in v0.14.1
func (v *StringSchema) OneOf(enum []string, options ...TestOption) *StringSchema
Test: checks that the value is one of the enum values
func (*StringSchema) Optional ¶ added in v0.14.1
func (v *StringSchema) Optional() *StringSchema
marks field as optional
func (*StringSchema) Parse ¶ added in v0.14.1
func (v *StringSchema) Parse(data any, dest *string, options ...ParsingOption) p.ZogErrList
Parses the data into the destination string. Returns a list of errors
func (*StringSchema) PostTransform ¶ added in v0.14.1
func (v *StringSchema) PostTransform(transform p.PostTransform) *StringSchema
Adds posttransform function to schema
func (*StringSchema) PreTransform ¶ added in v0.14.1
func (v *StringSchema) PreTransform(transform p.PreTransform) *StringSchema
Adds pretransform function to schema
func (*StringSchema) Required ¶ added in v0.14.1
func (v *StringSchema) Required(options ...TestOption) *StringSchema
marks field as required
func (*StringSchema) Test ¶ added in v0.14.1
func (v *StringSchema) Test(t p.Test, opts ...TestOption) *StringSchema
! Tests custom test function call it -> schema.Test(t z.Test, opts ...TestOption)
func (*StringSchema) Trim ¶ added in v0.14.1
func (v *StringSchema) Trim() *StringSchema
PreTransform: trims the input data of whitespace if it is a string
func (*StringSchema) URL ¶ added in v0.14.1
func (v *StringSchema) URL(options ...TestOption) *StringSchema
Test: checks that the value is a valid URL
func (*StringSchema) UUID ¶ added in v0.14.1
func (v *StringSchema) UUID(options ...TestOption) *StringSchema
Test: checks that the value is a valid uuid
func (*StringSchema) Validate ¶ added in v0.15.0
func (v *StringSchema) Validate(data *string) p.ZogErrList
Validate Given string
type StructSchema ¶ added in v0.14.1
type StructSchema struct {
// contains filtered or unexported fields
}
func Struct ¶
func Struct(schema Schema) *StructSchema
Returns a new StructSchema which can be used to parse input data into a struct
func (*StructSchema) Extend ¶ added in v0.14.1
func (v *StructSchema) Extend(schema Schema) *StructSchema
Extend creates a new schema by adding additional fields from the provided schema. Fields in the provided schema override any existing fields with the same key.
Parameters:
- schema: The schema containing fields to add
Returns a new schema with the additional fields
func (*StructSchema) Merge ¶ added in v0.14.1
func (v *StructSchema) Merge(other *StructSchema, others ...*StructSchema) *StructSchema
Merge combines two or more schemas into a new schema. It performs a shallow merge, meaning:
- Fields with the same key from later schemas override earlier ones
- PreTransforms, PostTransforms and tests are concatenated in order
- Modifying nested schemas may affect the original schemas
Parameters:
- other: The first schema to merge with
- others: Additional schemas to merge
Returns a new schema containing the merged fields and transforms
func (*StructSchema) Omit ¶ added in v0.14.1
func (v *StructSchema) Omit(vals ...any) *StructSchema
Omit creates a new schema with specified fields removed. It accepts either strings or map[string]bool as arguments:
- Strings directly specify fields to omit
- For maps, fields are omitted when their boolean value is true
Returns a new schema with the specified fields removed
func (*StructSchema) Optional ¶ added in v0.14.1
func (v *StructSchema) Optional() *StructSchema
marks field as optional
func (*StructSchema) Parse ¶ added in v0.14.1
func (v *StructSchema) Parse(data any, destPtr any, options ...ParsingOption) p.ZogErrMap
Parses val into destPtr and validates each field based on the schema. Only supports val = map[string]any & dest = &struct
func (*StructSchema) Pick ¶ added in v0.14.1
func (v *StructSchema) Pick(picks ...any) *StructSchema
Pick creates a new schema keeping only the specified fields. It accepts either strings or map[string]bool as arguments:
- Strings directly specify fields to keep
- For maps, fields are kept when their boolean value is true
Returns a new schema containing only the specified fields
func (*StructSchema) PostTransform ¶ added in v0.14.1
func (v *StructSchema) PostTransform(transform p.PostTransform) *StructSchema
Adds posttransform function to schema
func (*StructSchema) PreTransform ¶ added in v0.14.1
func (v *StructSchema) PreTransform(transform p.PreTransform) *StructSchema
Add a pretransform step to the schema
func (*StructSchema) Required ¶ added in v0.14.1
func (v *StructSchema) Required(options ...TestOption) *StructSchema
marks field as required
func (*StructSchema) Test ¶ added in v0.14.1
func (v *StructSchema) Test(t p.Test, opts ...TestOption) *StructSchema
! VALIDATORS custom test function call it -> schema.Test(t z.Test, opts ...TestOption)
type Test ¶
Test is the test object. It is the struct that represents an individual validation. For example `z.String().Min(3)` is a test that checks if the string is at least 3 characters long.
type TestOption ¶
Options that can be passed to a test
func Message ¶
func Message(msg string) TestOption
Message is a function that allows you to set a custom message for the test.
func MessageFunc ¶
func MessageFunc(fn p.ErrFmtFunc) TestOption
MessageFunc is a function that allows you to set a custom message formatter for the test.
type TimeFunc ¶ added in v0.12.0
type TimeFunc func(opts ...SchemaOption) *TimeSchema
var Time TimeFunc = func(opts ...SchemaOption) *TimeSchema { t := &TimeSchema{ coercer: conf.Coercers.Time, } for _, opt := range opts { opt(t) } return t }
Returns a new Time Schema
func (TimeFunc) Format ¶ added in v0.12.0
func (t TimeFunc) Format(format string) SchemaOption
Sets the string format for the time schema Usage is: z.Time(z.Time.Format(time.RFC3339))
func (TimeFunc) FormatFunc ¶ added in v0.12.0
Sets the format function for the time schema Usage is:
z.Time(z.Time.FormatFunc(func(data string) (time.Time, error) {
return time.Parse(time.RFC3339, data)
}))
type TimeSchema ¶ added in v0.14.1
type TimeSchema struct {
// contains filtered or unexported fields
}
func (*TimeSchema) After ¶ added in v0.14.1
func (v *TimeSchema) After(t time.Time, opts ...TestOption) *TimeSchema
Checks that the value is after the given time
func (*TimeSchema) Before ¶ added in v0.14.1
func (v *TimeSchema) Before(t time.Time, opts ...TestOption) *TimeSchema
Checks that the value is before the given time
func (*TimeSchema) Catch ¶ added in v0.14.1
func (v *TimeSchema) Catch(val time.Time) *TimeSchema
sets the catch value (i.e the value to use if the validation fails)
func (*TimeSchema) Default ¶ added in v0.14.1
func (v *TimeSchema) Default(val time.Time) *TimeSchema
sets the default value
func (*TimeSchema) EQ ¶ added in v0.14.1
func (v *TimeSchema) EQ(t time.Time, opts ...TestOption) *TimeSchema
Checks that the value is equal to the given time
func (*TimeSchema) Optional ¶ added in v0.14.1
func (v *TimeSchema) Optional() *TimeSchema
marks field as optional
func (*TimeSchema) Parse ¶ added in v0.14.1
func (v *TimeSchema) Parse(data any, dest *time.Time, options ...ParsingOption) p.ZogErrList
Parses the data into the destination time.Time. Returns a list of errors
func (*TimeSchema) PostTransform ¶ added in v0.14.1
func (v *TimeSchema) PostTransform(transform p.PostTransform) *TimeSchema
Adds posttransform function to schema
func (*TimeSchema) PreTransform ¶ added in v0.14.1
func (v *TimeSchema) PreTransform(transform p.PreTransform) *TimeSchema
Adds pretransform function to schema
func (*TimeSchema) Required ¶ added in v0.14.1
func (v *TimeSchema) Required(options ...TestOption) *TimeSchema
marks field as required
func (*TimeSchema) Test ¶ added in v0.14.1
func (v *TimeSchema) Test(t p.Test, opts ...TestOption) *TimeSchema
custom test function call it -> schema.Test("error_code", func(val any, ctx ParseCtx) bool {return true})
func (*TimeSchema) Validate ¶ added in v0.15.0
func (v *TimeSchema) Validate(data *time.Time) p.ZogErrList
Validates an existing time.Time
type ZogErrList ¶
type ZogErrList = p.ZogErrList
This is a type for the ZogErrList type. It is a list of ZogErrors returned from parsing primitive schemas. The type is []ZogError
type ZogErrMap ¶
This is a type for the ZogErrMap type. It is a map[string][]ZogError returned from parsing complex schemas. The type is map[string][]ZogError All errors are returned in a flat map, not matter how deep the schema is. For example:
schema := z.Struct(z.Schema{
"address": z.Struct(z.Schema{
"street": z.String().Min(3).Max(10),
"city": z.String().Min(3).Max(10),
}),
"fields": z.Slice(z.String().Min(3).Max(10)),
})
errors = map[string][]ZogError{
"address.street": []ZogError{....}, // error for the street field in the address struct
"fields[0]": []ZogError{...}, // error for the first field in the slice
}
type ZogError ¶
This is a type for the ZogError interface. It is the interface that all errors returned from zog implement.
type ZogSchema ¶ added in v0.12.0
type ZogSchema interface {
// contains filtered or unexported methods
}
The ZogSchema is the interface all schemas must implement This is most useful for internal use. If you are looking to pass schemas around, use the ComplexZogSchema or PrimitiveZogSchema interfaces if possible.