jschema

type ASTNode struct {
	// JSONType corresponding JSON type for this AST node's value.
	JSONType JSONType

	// SchemaType corresponding schema type for this AST node's value.
	SchemaType string

	// Value a node value.
	// Make sense only for scalars and shortcuts.
	Value string

	// Comment a ast node comment.
	Comment string

	// Rules a map of attached rules.
	Rules *RuleASTNodes

	// Properties contains all object properties.
	// Make sense only for objects.
	Properties *ASTNodes

	// Items contains all array items.
	// Make sense only for arrays.
	Items []ASTNode

	// IsKeyShortcut will be true if this property key is shortcut.
	// Make sense only for AST nodes which are represents object property.
	IsKeyShortcut bool
}

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

type ASTNodesItem struct {
	Key   string
	Value ASTNode
}

type Document interface {
	// NextLexeme returns next lexeme from this document.
	// Might return ParsingError if document isn't valid.
	// Will return io.EOF when no more lexemes are available.
	NextLexeme() (lexeme.LexEvent, error)

	// Len returns length of document in bytes.
	// Might return ParsingError if document isn't valid.
	Len() (uint, error)

	// Check checks that this document is valid.
	// Can return ParsingError if document isn't valid.
	Check() error
}

type JSONType = string

type ParsingError interface {
	error

	// Position returns position of buggy character.
	Position() uint

	// Message returns an error message.
	Message() string

	// ErrCode returns an error code.
	ErrCode() int
}

type Rule interface{}

type RuleASTNode struct {
	// JSONType corresponding JSON type for this AST node's value.
	JSONType JSONType

	// Value a node value.
	// Make sense only for scalars and shortcuts.
	Value string

	// Comment a ast node comment.
	Comment string

	// Properties contains all object properties.
	// Make sense only for objects.
	Properties *RuleASTNodes

	// Items contains all array items.
	// Make sense only for arrays.
	Items []RuleASTNode

	// Source a source of this rule.
	Source RuleASTNodeSource
}

type RuleASTNodeSource int

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

type RuleASTNodesItem struct {
	Key   string
	Value RuleASTNode
}

type Schema interface {
	// Len returns length of this schema in bytes.
	// Might return ParsingError if schema isn't valid.
	Len() (uint, error)

	// Example returns an example for this schema.
	// Might return ParsingError if schema isn't valid.
	Example() ([]byte, error)

	// AddType adds a new type to this schema.
	// Might return a ParsingError if add type isn't valid.
	AddType(name string, schema Schema) error

	// AddRule adds a new type to this schema.
	// Might return a ParsingError if add type isn't valid.
	AddRule(name string, schema Rule) error

	// Check checks that this schema is valid.
	// Can return ParsingError if schema isn't valid.
	Check() error

	// Validate validates specified document.
	// Might return a ParsingError if schema isn't valid.
	// Can return a ValidationError if specified document isn't valid for this
	// schema.
	Validate(Document) error

	// GetAST returns a root AST node for this schema.
	GetAST() (ASTNode, error)

	// UsedUserTypes return all used user types.
	UsedUserTypes() ([]string, error)
}

type SchemaType string

type ValidationError interface {
	error

	// Message returns an error message.
	Message() string

	// ErrCode returns an error code.
	ErrCode() int
}