jschema

Documentation

Index

• func UserTypeNamesFromEachTypeConstraint(node ischema.Node) []string
• func UserTypeNamesFromTypeConstraint(node ischema.Node) []string
• func UserTypeNamesFromTypesListConstraint(node ischema.Node) []string
• type JSchema
  • func FromFile(f *fs.File, oo ...Option) *JSchema
  • func FromRSchema(s *regex.RSchema) (*JSchema, error)
  • func New[T bytes.ByteKeeper](name string, content T, oo ...Option) *JSchema
  • func (s *JSchema) AddRule(n string, r schema.Rule) error
  • func (s *JSchema) AddType(name string, sc schema.Schema) (err error)
  • func (s *JSchema) BuildASTNode() schema.ASTNode
  • func (s *JSchema) Check() (err error)
  • func (s *JSchema) CollectUserTypes()
  • func (s *JSchema) Compile() error
  • func (s *JSchema) Example() (b []byte, err error)
  • func (s *JSchema) GetAST() (an schema.ASTNode, err error)
  • func (s *JSchema) InnerTypesList() map[string]ischema.Type
  • func (s *JSchema) Len() (uint, error)
  • func (s *JSchema) UsedUserTypes() ([]string, error)
• type Option
• type StringSet
  • func NewStringSet(vv ...string) *StringSet
  • func (m *StringSet) Add(v string)
  • func (m *StringSet) Data() []string
  • func (m *StringSet) Has(v string) bool
  • func (m *StringSet) Len() int

Functions

func UserTypeNamesFromEachTypeConstraint

func UserTypeNamesFromEachTypeConstraint(node ischema.Node) []string

func UserTypeNamesFromTypeConstraint

func UserTypeNamesFromTypeConstraint(node ischema.Node) []string

func UserTypeNamesFromTypesListConstraint

func UserTypeNamesFromTypesListConstraint(node ischema.Node) []string

Types

type JSchema

type JSchema struct {
	File  *fs.File
	Inner *ischema.ISchema

	Rules map[string]schema.Rule

	// UserTypesNamesUsed the names of the USER TYPES mentioned in the schema.
	// They are collected from the schema when it is loaded.
	UserTypesNamesUsed *StringSet

	// UserTypeCollection is a list of added USER TYPES. Not all of them can actually be used in the schema.
	// Required for the OpenAPI converter.
	UserTypeCollection map[string]schema.Schema

	LenOnce     sync.ErrOnceWithValue[uint]
	LoadOnce    sync.ErrOnce
	CompileOnce sync.ErrOnce

	ASTNode                  schema.ASTNode
	AreKeysOptionalByDefault bool
}

func FromFile

func FromFile(f *fs.File, oo ...Option) *JSchema

FromFile creates a Jsight schema from file.

func FromRSchema

func FromRSchema(s *regex.RSchema) (*JSchema, error)

func New

func New[T bytes.ByteKeeper](name string, content T, oo ...Option) *JSchema

New creates a Jsight schema with specified name and content.

func (*JSchema) AddRule

func (s *JSchema) AddRule(n string, r schema.Rule) error

func (*JSchema) AddType

func (s *JSchema) AddType(name string, sc schema.Schema) (err error)

func (*JSchema) BuildASTNode

func (s *JSchema) BuildASTNode() schema.ASTNode

func (*JSchema) Check

func (s *JSchema) Check() (err error)

func (*JSchema) CollectUserTypes

func (s *JSchema) CollectUserTypes()

func (*JSchema) Compile

func (s *JSchema) Compile() error

func (*JSchema) Example

func (s *JSchema) Example() (b []byte, err error)

func (*JSchema) GetAST

func (s *JSchema) GetAST() (an schema.ASTNode, err error)

func (*JSchema) InnerTypesList

func (s *JSchema) InnerTypesList() map[string]ischema.Type

func (*JSchema) Len

func (s *JSchema) Len() (uint, error)

func (*JSchema) UsedUserTypes

func (s *JSchema) UsedUserTypes() ([]string, error)

type Option

type Option func(s *JSchema)

type StringSet

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

StringSet a set of strings. gen:Set

func NewStringSet

func NewStringSet(vv ...string) *StringSet

func (*StringSet) Add

func (m *StringSet) Add(v string)

Add adds specific value to set.

func (*StringSet) Data

func (m *StringSet) Data() []string

Data return set's data.

func (*StringSet) Has

func (m *StringSet) Has(v string) bool

Has checks that specified value is exists.

func (*StringSet) Len

func (m *StringSet) Len() int

Len returns len of set.