Help us shape the future of Go! Take the 2026 Go Developer Survey

field

package
v0.0.2 Latest Latest
Warning

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

 Go to latest Published: Aug 28, 2026 License: MIT Imports: 2 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type BoolField 

type BoolField struct {
	// contains filtered or unexported fields
}

func (*BoolField) Comment 

func (f *BoolField) Comment(text string) BoolFieldBuilder

func (*BoolField) Default 

func (f *BoolField) Default(value bool) BoolFieldBuilder

func (*BoolField) Field 

func (*BoolField) Field()

func (*BoolField) GetComment 

func (f *BoolField) GetComment() *string

func (*BoolField) GetDefault 

func (f *BoolField) GetDefault() *bool

func (*BoolField) GetPermissions 

func (f *BoolField) GetPermissions() permissions.Permission

func (*BoolField) GetProtoField 

func (f *BoolField) GetProtoField() *int

func (*BoolField) GetValidate 

func (f *BoolField) GetValidate() func(bool) bool

func (*BoolField) Permissions 

func (f *BoolField) Permissions(permission permissions.Permission) BoolFieldBuilder

func (*BoolField) ProtoField 

func (f *BoolField) ProtoField(num int) BoolFieldBuilder

func (*BoolField) Validate 

func (f *BoolField) Validate(fn func(bool) bool) BoolFieldBuilder

type BoolFieldBuilder 

type BoolFieldBuilder interface {
	Default(bool) BoolFieldBuilder
	ProtoField(int) BoolFieldBuilder
	Comment(string) BoolFieldBuilder
	Permissions(permissions.Permission) BoolFieldBuilder
	Validate(func(bool) bool) BoolFieldBuilder

	// to satisfy entlite.Field interface
	Field()
}

--------------------------------- bool ---------------------------------

func Bool 

func Bool(name string) BoolFieldBuilder

type ByteField 

type ByteField struct {
	// contains filtered or unexported fields
}

func (*ByteField) Comment 

func (f *ByteField) Comment(text string) ByteFieldBuilder

func (*ByteField) DefaultFunc 

func (f *ByteField) DefaultFunc(fn func() []byte) ByteFieldBuilder

func (*ByteField) Field 

func (*ByteField) Field()

func (*ByteField) GetComment 

func (f *ByteField) GetComment() *string

func (*ByteField) GetDefaultFunc 

func (f *ByteField) GetDefaultFunc() func() []byte

func (*ByteField) GetImmutable 

func (f *ByteField) GetImmutable() bool

func (*ByteField) GetOptional 

func (f *ByteField) GetOptional() bool

func (*ByteField) GetPermissions 

func (f *ByteField) GetPermissions() permissions.Permission

func (*ByteField) GetProtoField 

func (f *ByteField) GetProtoField() *int

func (*ByteField) GetUnique 

func (f *ByteField) GetUnique() bool

func (*ByteField) GetValidate 

func (f *ByteField) GetValidate() func([]byte) bool

func (*ByteField) Immutable 

func (f *ByteField) Immutable() ByteFieldBuilder

func (*ByteField) Optional 

func (f *ByteField) Optional() ByteFieldBuilder

func (*ByteField) Permissions 

func (f *ByteField) Permissions(permission permissions.Permission) ByteFieldBuilder

func (*ByteField) ProtoField 

func (f *ByteField) ProtoField(num int) ByteFieldBuilder

func (*ByteField) Unique 

func (f *ByteField) Unique() ByteFieldBuilder

func (*ByteField) Validate 

func (f *ByteField) Validate(fn func([]byte) bool) ByteFieldBuilder

type ByteFieldBuilder 

type ByteFieldBuilder interface {
	Unique() ByteFieldBuilder
	Optional() ByteFieldBuilder
	Immutable() ByteFieldBuilder
	ProtoField(int) ByteFieldBuilder
	Comment(string) ByteFieldBuilder
	Permissions(permissions.Permission) ByteFieldBuilder
	DefaultFunc(func() []byte) ByteFieldBuilder
	Validate(func([]byte) bool) ByteFieldBuilder

	Field()
}

--------------------------------- byte ---------------------------------

func Byte 

func Byte(name string) ByteFieldBuilder

type FloatField 

type FloatField struct {
	// contains filtered or unexported fields
}

func (*FloatField) Comment 

func (f *FloatField) Comment(text string) FloatFieldBuilder

func (*FloatField) Default 

func (f *FloatField) Default(value float64) FloatFieldBuilder

func (*FloatField) Field 

func (*FloatField) Field()

func (*FloatField) GetComment 

func (f *FloatField) GetComment() *string

func (*FloatField) GetDefault 

func (f *FloatField) GetDefault() *float64

func (*FloatField) GetOptional 

func (f *FloatField) GetOptional() bool

func (*FloatField) GetPermissions 

func (f *FloatField) GetPermissions() permissions.Permission

func (*FloatField) GetProtoField 

func (f *FloatField) GetProtoField() *int

func (*FloatField) GetValidate 

func (f *FloatField) GetValidate() func(float64) bool

func (*FloatField) Optional 

func (f *FloatField) Optional() FloatFieldBuilder

func (*FloatField) Permissions 

func (f *FloatField) Permissions(permission permissions.Permission) FloatFieldBuilder

func (*FloatField) ProtoField 

func (f *FloatField) ProtoField(num int) FloatFieldBuilder

func (*FloatField) Validate 

func (f *FloatField) Validate(fn func(float64) bool) FloatFieldBuilder

type FloatFieldBuilder 

type FloatFieldBuilder interface {
	Default(float64) FloatFieldBuilder
	ProtoField(int) FloatFieldBuilder
	Comment(string) FloatFieldBuilder
	Permissions(permissions.Permission) FloatFieldBuilder
	Optional() FloatFieldBuilder
	Validate(func(float64) bool) FloatFieldBuilder

	Field()
}

--------------------------------- float ---------------------------------

func Float 

func Float(name string) FloatFieldBuilder

type Int64Field 

type Int64Field struct {
	// contains filtered or unexported fields
}

func (*Int64Field) Comment 

func (f *Int64Field) Comment(text string) Int64FieldBuilder

func (*Int64Field) Default 

func (f *Int64Field) Default(value int64) Int64FieldBuilder

func (*Int64Field) Field 

func (*Int64Field) Field()

func (*Int64Field) GetComment 

func (f *Int64Field) GetComment() *string

func (*Int64Field) GetDefault 

func (f *Int64Field) GetDefault() *int64

func (*Int64Field) GetOptional 

func (f *Int64Field) GetOptional() bool

func (*Int64Field) GetPermissions 

func (f *Int64Field) GetPermissions() permissions.Permission

func (*Int64Field) GetProtoField 

func (f *Int64Field) GetProtoField() *int

func (*Int64Field) GetValidate 

func (f *Int64Field) GetValidate() func(int64) bool

func (*Int64Field) Optional 

func (f *Int64Field) Optional() Int64FieldBuilder

func (*Int64Field) Permissions 

func (f *Int64Field) Permissions(permission permissions.Permission) Int64FieldBuilder

func (*Int64Field) ProtoField 

func (f *Int64Field) ProtoField(num int) Int64FieldBuilder

func (*Int64Field) Validate 

func (f *Int64Field) Validate(fn func(int64) bool) Int64FieldBuilder

type Int64FieldBuilder 

type Int64FieldBuilder interface {
	Default(int64) Int64FieldBuilder
	ProtoField(int) Int64FieldBuilder
	Comment(string) Int64FieldBuilder
	Permissions(permissions.Permission) Int64FieldBuilder
	Optional() Int64FieldBuilder
	Validate(func(int64) bool) Int64FieldBuilder

	// to satisfy entlite.Field interface
	Field()
}

--------------------------------- int64 ---------------------------------

func Int64 

func Int64(name string) Int64FieldBuilder

type IntField 

type IntField struct {
	// contains filtered or unexported fields
}

func (*IntField) Comment 

func (f *IntField) Comment(text string) IntFieldBuilder

func (*IntField) Default 

func (f *IntField) Default(value int32) IntFieldBuilder

func (*IntField) Field 

func (*IntField) Field()

func (*IntField) GetComment 

func (f *IntField) GetComment() *string

func (*IntField) GetDefault 

func (f *IntField) GetDefault() *int32

func (*IntField) GetOptional 

func (f *IntField) GetOptional() bool

func (*IntField) GetPermissions 

func (f *IntField) GetPermissions() permissions.Permission

func (*IntField) GetProtoField 

func (f *IntField) GetProtoField() *int

func (*IntField) GetValidate 

func (f *IntField) GetValidate() func(int32) bool

func (*IntField) Optional 

func (f *IntField) Optional() IntFieldBuilder

func (*IntField) Permissions 

func (f *IntField) Permissions(permission permissions.Permission) IntFieldBuilder

func (*IntField) ProtoField 

func (f *IntField) ProtoField(num int) IntFieldBuilder

func (*IntField) Validate 

func (f *IntField) Validate(fn func(int32) bool) IntFieldBuilder

type IntFieldBuilder 

type IntFieldBuilder interface {
	Default(int32) IntFieldBuilder
	ProtoField(int) IntFieldBuilder
	Comment(string) IntFieldBuilder
	Permissions(permissions.Permission) IntFieldBuilder
	Optional() IntFieldBuilder
	Validate(func(int32) bool) IntFieldBuilder

	// to satisfy entlite.Field interface
	Field()
}

--------------------------------- int --------------------------------- int uses int32 as type under the hood - for DX experience with JS number

func Int 

func Int(name string) IntFieldBuilder

type JSONField 

type JSONField struct {
	// contains filtered or unexported fields
}

func (*JSONField) Comment 

func (f *JSONField) Comment(text string) JSONFieldBuilder

func (*JSONField) Default 

func (f *JSONField) Default(value string) JSONFieldBuilder

func (*JSONField) DefaultFunc 

func (f *JSONField) DefaultFunc(fn func() string) JSONFieldBuilder

func (*JSONField) Field 

func (*JSONField) Field()

func (*JSONField) GetComment 

func (f *JSONField) GetComment() *string

func (*JSONField) GetDefault 

func (f *JSONField) GetDefault() *string

func (*JSONField) GetDefaultFunc 

func (f *JSONField) GetDefaultFunc() func() string

func (*JSONField) GetImmutable 

func (f *JSONField) GetImmutable() bool

func (*JSONField) GetOptional 

func (f *JSONField) GetOptional() bool

func (*JSONField) GetPermissions 

func (f *JSONField) GetPermissions() permissions.Permission

func (*JSONField) GetProtoField 

func (f *JSONField) GetProtoField() *int

func (*JSONField) GetValidate 

func (f *JSONField) GetValidate() func(string) bool

func (*JSONField) Immutable 

func (f *JSONField) Immutable() JSONFieldBuilder

func (*JSONField) Optional 

func (f *JSONField) Optional() JSONFieldBuilder

func (*JSONField) Permissions 

func (f *JSONField) Permissions(permission permissions.Permission) JSONFieldBuilder

func (*JSONField) ProtoField 

func (f *JSONField) ProtoField(num int) JSONFieldBuilder

func (*JSONField) Validate 

func (f *JSONField) Validate(fn func(string) bool) JSONFieldBuilder

type JSONFieldBuilder 

type JSONFieldBuilder interface {
	Optional() JSONFieldBuilder
	Immutable() JSONFieldBuilder
	ProtoField(int) JSONFieldBuilder
	Comment(string) JSONFieldBuilder
	Permissions(permissions.Permission) JSONFieldBuilder
	// Default takes raw json text, e.g. `{}` or `{"theme":"dark"}`
	Default(string) JSONFieldBuilder
	DefaultFunc(func() string) JSONFieldBuilder
	Validate(func(string) bool) JSONFieldBuilder

	Field()
}

--------------------------------- json ---------------------------------

func JSON 

func JSON(name string) JSONFieldBuilder

type StringField 

type StringField struct {
	// contains filtered or unexported fields
}

func (*StringField) Comment 

func (f *StringField) Comment(text string) StringFieldBuilder

func (*StringField) Default 

func (f *StringField) Default(value string) StringFieldBuilder

func (*StringField) DefaultFunc 

func (f *StringField) DefaultFunc(fn func() string) StringFieldBuilder

func (*StringField) Field 

func (*StringField) Field()

marker method for sealed interface

func (*StringField) GetComment 

func (f *StringField) GetComment() *string

func (*StringField) GetDefault 

func (f *StringField) GetDefault() *string

func (*StringField) GetDefaultFunc 

func (f *StringField) GetDefaultFunc() func() string

func (*StringField) GetImmutable 

func (f *StringField) GetImmutable() bool

func (*StringField) GetOptional 

func (f *StringField) GetOptional() bool

func (*StringField) GetPermissions 

func (f *StringField) GetPermissions() permissions.Permission

func (*StringField) GetProtoField 

func (f *StringField) GetProtoField() *int

func (*StringField) GetUnique 

func (f *StringField) GetUnique() bool

func (*StringField) GetValidate 

func (f *StringField) GetValidate() func(string) bool

func (*StringField) Immutable 

func (f *StringField) Immutable() StringFieldBuilder

func (*StringField) Optional 

func (f *StringField) Optional() StringFieldBuilder

func (*StringField) Permissions 

func (f *StringField) Permissions(permission permissions.Permission) StringFieldBuilder

func (*StringField) ProtoField 

func (f *StringField) ProtoField(num int) StringFieldBuilder

func (*StringField) Unique 

func (f *StringField) Unique() StringFieldBuilder

setters with chaining logic. uses mutable struct

func (*StringField) Validate 

func (f *StringField) Validate(fn func(string) bool) StringFieldBuilder

type StringFieldBuilder 

type StringFieldBuilder interface {
	Unique() StringFieldBuilder
	Default(string) StringFieldBuilder
	DefaultFunc(func() string) StringFieldBuilder
	ProtoField(int) StringFieldBuilder
	Comment(string) StringFieldBuilder
	Permissions(permissions.Permission) StringFieldBuilder
	Immutable() StringFieldBuilder
	Optional() StringFieldBuilder
	Validate(func(string) bool) StringFieldBuilder

	// to satisfy entlite.Field interface
	Field()
}

--------------------------------- string ---------------------------------

func String 

func String(name string) StringFieldBuilder

constructor

type TimeField 

type TimeField struct {
	// contains filtered or unexported fields
}

func (*TimeField) Comment 

func (f *TimeField) Comment(text string) TimeFieldBuilder

func (*TimeField) Default 

func (f *TimeField) Default(value time.Time) TimeFieldBuilder

func (*TimeField) DefaultFunc 

func (f *TimeField) DefaultFunc(fn func() time.Time) TimeFieldBuilder

func (*TimeField) Field 

func (*TimeField) Field()

func (*TimeField) GetComment 

func (f *TimeField) GetComment() *string

func (*TimeField) GetDefault 

func (f *TimeField) GetDefault() *time.Time

func (*TimeField) GetDefaultFunc 

func (f *TimeField) GetDefaultFunc() func() time.Time

func (*TimeField) GetImmutable 

func (f *TimeField) GetImmutable() bool

func (*TimeField) GetOptional 

func (f *TimeField) GetOptional() bool

func (*TimeField) GetPermissions 

func (f *TimeField) GetPermissions() permissions.Permission

func (*TimeField) GetProtoField 

func (f *TimeField) GetProtoField() *int

func (*TimeField) GetValidate 

func (f *TimeField) GetValidate() func(time.Time) bool

func (*TimeField) Immutable 

func (f *TimeField) Immutable() TimeFieldBuilder

func (*TimeField) Optional 

func (f *TimeField) Optional() TimeFieldBuilder

func (*TimeField) Permissions 

func (f *TimeField) Permissions(permission permissions.Permission) TimeFieldBuilder

func (*TimeField) ProtoField 

func (f *TimeField) ProtoField(num int) TimeFieldBuilder

func (*TimeField) Validate 

func (f *TimeField) Validate(fn func(time.Time) bool) TimeFieldBuilder

type TimeFieldBuilder 

type TimeFieldBuilder interface {
	Default(time.Time) TimeFieldBuilder
	DefaultFunc(func() time.Time) TimeFieldBuilder
	ProtoField(int) TimeFieldBuilder
	Comment(string) TimeFieldBuilder
	Permissions(permissions.Permission) TimeFieldBuilder
	Immutable() TimeFieldBuilder
	Optional() TimeFieldBuilder
	Validate(func(time.Time) bool) TimeFieldBuilder

	Field()
}

--------------------------------- time ---------------------------------

func Time 

func Time(name string) TimeFieldBuilder

Source Files

View all Source files

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.