builder

package module
v0.0.0-...-501dc45 Latest Latest
Warning

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

Go to latest
Published: May 4, 2023 License: MIT Imports: 7 Imported by: 0

Documentation

Index

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) Doc

func (t ArrayBuilder) Doc(stmts ...string) R

func (ArrayBuilder) Format

func (t ArrayBuilder) Format(v string) R

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 ArrayMetadata struct {
	MaxItems int64 `json:"maxitems,omitempty"`
	MinItems int64 `json:"minitems,omitempty"`
}

type ArrayType

type ArrayType[T TypeBuilder] struct {
	*ArrayBuilder[T, *ArrayType[T]]
}

func (ArrayType) Doc

func (t ArrayType) Doc(stmts ...string) R

func (ArrayType) Format

func (t ArrayType) Format(v string) R

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 New

func New() *Builder

func (*Builder) Array

func (b *Builder) Array(typ TypeBuilder) *ArrayType[TypeBuilder]

func (*Builder) EachTypes

func (b *Builder) EachTypes(fn func(TypeBuilder) error) error

func (*Builder) Field

func (b *Builder) Field(name string, typ TypeBuilder) *Field

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 (b *Builder) ReferenceByName(name string) *TypeRef

func (*Builder) String

func (b *Builder) String() *StringType

type Field

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

func (Field) Doc

func (t Field) Doc(stmts ...string) R

func (*Field) GetFieldMetadata

func (f *Field) GetFieldMetadata() *FieldMetadata

func (Field) Required

func (t Field) Required(v bool) R

type FieldMetadata

type FieldMetadata struct {
	Name        string `json:"-"`
	Description string `json:"description,omitempty"`
	Required    bool   `json:"-"`
}

type IntegerBuilder

type IntegerBuilder[R TypeBuilder] struct {
	// contains filtered or unexported fields
}

func (IntegerBuilder) Doc

func (t IntegerBuilder) Doc(stmts ...string) R

func (IntegerBuilder) Format

func (t IntegerBuilder) Format(v string) R

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 IntegerMetadata struct {
	// minimum ≤ value ≤ maximum
	Maximum int64 `json:"maximum,omitempty"`
	Minimum int64 `json:"minimum,omitempty"`
}

type IntegerType

type IntegerType struct {
	*IntegerBuilder[*IntegerType]
}

func (IntegerType) Doc

func (t IntegerType) Doc(stmts ...string) R

func (IntegerType) Format

func (t IntegerType) Format(v string) R

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) Doc

func (t MapBuilder) Doc(stmts ...string) R

func (MapBuilder) Format

func (t MapBuilder) Format(v string) R

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) Doc

func (t MapType) Doc(stmts ...string) R

func (MapType) Format

func (t MapType) Format(v string) R

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) Doc

func (t ObjectBuilder) Doc(stmts ...string) R

func (ObjectBuilder) Format

func (t ObjectBuilder) Format(v string) R

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) Doc

func (t ObjectType) Doc(stmts ...string) R

func (ObjectType) Format

func (t ObjectType) Format(v string) R

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) Doc

func (t StringBuilder) Doc(stmts ...string) R

func (StringBuilder) Format

func (t StringBuilder) Format(v string) R

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 StringMetadata struct {
	MinLength int64  `json:"minlength,omitempty"`
	MaxLength int64  `json:"maxlength,omitempty"`
	Pattern   string `json:"pattern,omitempty"`
}

type StringType

type StringType struct {
	*StringBuilder[*StringType]
}

func (StringType) Doc

func (t StringType) Doc(stmts ...string) R

func (StringType) Format

func (t StringType) Format(v string) R

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 TypeMetadata struct {
	Name        string `json:"-"`
	Description string `json:"description,omitempty"`
	Format      string `json:"format,omitempty"`

	IsNewType bool `json:"-"`
	// contains filtered or unexported fields
}

type TypeRef

type TypeRef struct {
	Name string
	// contains filtered or unexported fields
}

func (*TypeRef) GetTypeMetadata

func (t *TypeRef) GetTypeMetadata() *TypeMetadata

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
⌂ 换网址