Documentation
¶
Index ¶
- func Define[T interface{ ... }](name string, typ T) T
- func ToSchema(b *Builder) (*orderedmap.OrderedMap, error)
- func ToString(typ TypeBuilder) string
- type ArrayBuilder
- type ArrayMetadata
- type ArrayType
- type Builder
- func (b *Builder) Array(typ TypeBuilder) *ArrayType[TypeBuilder]
- func (b *Builder) EachTypes(fn func(TypeBuilder) error) error
- func (b *Builder) Field(name string, typ TypeBuilder) *Field
- func (b *Builder) Integer() *IntegerType
- func (b *Builder) Map(valtyp TypeBuilder) *MapType[TypeBuilder]
- func (b *Builder) Object(fields ...*Field) *ObjectType
- func (b *Builder) Reference(typ TypeBuilder) *TypeRef
- func (b *Builder) ReferenceByName(name string) *TypeRef
- func (b *Builder) String() *StringType
- type Field
- type FieldMetadata
- type IntegerBuilder
- type IntegerMetadata
- type IntegerType
- type MapBuilder
- type MapMetadata
- type MapType
- type ObjectBuilder
- type ObjectMetadata
- type ObjectType
- type StringBuilder
- type StringMetadata
- type StringType
- type TypeBuilder
- type TypeMetadata
- type TypeRef
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Define ¶
func Define[T interface {
TypeBuilder
storeType(name string)
}](name string, typ T) T
func ToSchema ¶
func ToSchema(b *Builder) (*orderedmap.OrderedMap, error)
func ToString ¶
func ToString(typ TypeBuilder) string
Types ¶
type ArrayBuilder ¶
type ArrayBuilder[T TypeBuilder, R TypeBuilder] struct { // contains filtered or unexported fields }
func (ArrayBuilder) GetTypeMetadata ¶
func (t ArrayBuilder) GetTypeMetadata() *TypeMetadata
func (*ArrayBuilder[T, R]) MaxItems ¶
func (t *ArrayBuilder[T, R]) MaxItems(n int64) R
func (*ArrayBuilder[T, R]) MinItems ¶
func (t *ArrayBuilder[T, R]) MinItems(n int64) R
type ArrayMetadata ¶
type ArrayType ¶
type ArrayType[T TypeBuilder] struct { *ArrayBuilder[T, *ArrayType[T]] }
func (*ArrayType[T]) GetMetadata ¶
func (t *ArrayType[T]) GetMetadata() *ArrayMetadata
func (ArrayType) GetTypeMetadata ¶
func (t ArrayType) GetTypeMetadata() *TypeMetadata
type Builder ¶
type Builder struct {
// contains filtered or unexported fields
}
func (*Builder) Array ¶
func (b *Builder) Array(typ TypeBuilder) *ArrayType[TypeBuilder]
func (*Builder) Integer ¶
func (b *Builder) Integer() *IntegerType
func (*Builder) Map ¶
func (b *Builder) Map(valtyp TypeBuilder) *MapType[TypeBuilder]
func (*Builder) Object ¶
func (b *Builder) Object(fields ...*Field) *ObjectType
func (*Builder) Reference ¶
func (b *Builder) Reference(typ TypeBuilder) *TypeRef
func (*Builder) ReferenceByName ¶
func (*Builder) String ¶
func (b *Builder) String() *StringType
type Field ¶
type Field struct {
// contains filtered or unexported fields
}
func (*Field) GetFieldMetadata ¶
func (f *Field) GetFieldMetadata() *FieldMetadata
type FieldMetadata ¶
type IntegerBuilder ¶
type IntegerBuilder[R TypeBuilder] struct { // contains filtered or unexported fields }
func (IntegerBuilder) GetTypeMetadata ¶
func (t IntegerBuilder) GetTypeMetadata() *TypeMetadata
func (*IntegerBuilder[R]) Maximum ¶
func (t *IntegerBuilder[R]) Maximum(n int64) R
func (*IntegerBuilder[R]) Minimum ¶
func (t *IntegerBuilder[R]) Minimum(n int64) R
type IntegerMetadata ¶
type IntegerType ¶
type IntegerType struct {
*IntegerBuilder[*IntegerType]
}
func (*IntegerType) GetMetadata ¶
func (t *IntegerType) GetMetadata() *IntegerMetadata
func (IntegerType) GetTypeMetadata ¶
func (t IntegerType) GetTypeMetadata() *TypeMetadata
type MapBuilder ¶
type MapBuilder[V TypeBuilder, R TypeBuilder] struct { // contains filtered or unexported fields }
string only map
func (MapBuilder) GetTypeMetadata ¶
func (t MapBuilder) GetTypeMetadata() *TypeMetadata
func (*MapBuilder[T, R]) PatternProperties ¶
func (t *MapBuilder[T, R]) PatternProperties(s string, typ TypeBuilder) R
type MapMetadata ¶
type MapMetadata struct {
PatternProperties map[string]TypeBuilder `json:"-,omitempty"`
}
type MapType ¶
type MapType[T TypeBuilder] struct { *MapBuilder[T, *MapType[T]] }
func (*MapType[T]) GetMetadata ¶
func (t *MapType[T]) GetMetadata() *MapMetadata
func (MapType) GetTypeMetadata ¶
func (t MapType) GetTypeMetadata() *TypeMetadata
type ObjectBuilder ¶
type ObjectBuilder[R TypeBuilder] struct { Fields []*Field // contains filtered or unexported fields }
func (ObjectBuilder) GetTypeMetadata ¶
func (t ObjectBuilder) GetTypeMetadata() *TypeMetadata
func (*ObjectBuilder[R]) String ¶
func (b *ObjectBuilder[R]) String(v bool) R
type ObjectMetadata ¶
type ObjectMetadata struct {
Strict bool `json:"-"`
}
type ObjectType ¶
type ObjectType struct {
*ObjectBuilder[*ObjectType]
}
func (*ObjectType) GetMetadata ¶
func (t *ObjectType) GetMetadata() *ObjectMetadata
func (ObjectType) GetTypeMetadata ¶
func (t ObjectType) GetTypeMetadata() *TypeMetadata
type StringBuilder ¶
type StringBuilder[R TypeBuilder] struct { // contains filtered or unexported fields }
func (StringBuilder) GetTypeMetadata ¶
func (t StringBuilder) GetTypeMetadata() *TypeMetadata
func (*StringBuilder[R]) MaxLength ¶
func (t *StringBuilder[R]) MaxLength(n int64) R
func (*StringBuilder[R]) MinLength ¶
func (t *StringBuilder[R]) MinLength(n int64) R
func (*StringBuilder[R]) Pattern ¶
func (t *StringBuilder[R]) Pattern(s string) R
type StringMetadata ¶
type StringType ¶
type StringType struct {
*StringBuilder[*StringType]
}
func (*StringType) GetMetadata ¶
func (t *StringType) GetMetadata() *StringMetadata
func (StringType) GetTypeMetadata ¶
func (t StringType) GetTypeMetadata() *TypeMetadata
type TypeBuilder ¶
type TypeBuilder interface {
GetTypeMetadata() *TypeMetadata
// contains filtered or unexported methods
}
type TypeMetadata ¶
type TypeRef ¶
type TypeRef struct {
Name string
// contains filtered or unexported fields
}
func (*TypeRef) GetTypeMetadata ¶
func (t *TypeRef) GetTypeMetadata() *TypeMetadata
Click to show internal directories.
Click to hide internal directories.