requirementsourcecodec

Documentation

Index

• Constants
• func ErrorCode(err error) string
• func Format(model requirementsourcemodel.Model) ([]byte, error)
• func FormatWithLimits(model requirementsourcemodel.Model, codecLimits Limits, ...) ([]byte, error)
• func MaxCanonicalBytes(limits requirementsourcemodel.Limits) (int64, error)
• func MaxLexicalTokens(limits requirementsourcemodel.Limits) (int, error)
• type ByteSpan
• type Diagnostic
• type Error
  • func (err *Error) Diagnostic() Diagnostic
  • func (err *Error) Error() string
• type Limits
  • func DefaultLimits() Limits
• type Location
• type Position
• type Result
  • func Parse(source []byte) (Result, error)
  • func ParseWithLimits(source []byte, codecLimits Limits, modelLimits requirementsourcemodel.Limits) (Result, error)
• type SourceMap
  • func (sourceMap SourceMap) Location(pointer string) (Location, bool)
  • func (sourceMap SourceMap) Pointers() []string

Constants

const (
	SchemaVersion = 2
	DocumentKind  = "proofkit.requirement-source"
)

Functions

func ErrorCode

func ErrorCode(err error) string

func Format

func Format(model requirementsourcemodel.Model) ([]byte, error)

func FormatWithLimits

func FormatWithLimits(model requirementsourcemodel.Model, codecLimits Limits, modelLimits requirementsourcemodel.Limits) ([]byte, error)

func MaxCanonicalBytes

func MaxCanonicalBytes(limits requirementsourcemodel.Limits) (int64, error)

func MaxLexicalTokens

func MaxLexicalTokens(limits requirementsourcemodel.Limits) (int, error)

Types

type ByteSpan

type ByteSpan struct {
	Start int64
	End   int64
}

type Diagnostic

type Diagnostic struct {
	Code            string
	Path            string
	Span            ByteSpan
	CoordinateState string
	Start           *Position
	End             *Position
}

type Error

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

func (*Error) Diagnostic

func (err *Error) Diagnostic() Diagnostic

func (*Error) Error

func (err *Error) Error() string

type Limits

type Limits struct {
	MaxRawBytes    int64
	MaxTokens      int
	MaxNesting     int
	MaxOutputBytes int64
}

func DefaultLimits

func DefaultLimits() Limits

type Location

type Location struct {
	KeySpan   *ByteSpan
	ValueSpan ByteSpan
	Start     Position
	End       Position
}

type Position

type Position struct {
	Line         int
	ScalarColumn int
}

type Result

type Result struct {
	Model     requirementsourcemodel.Model
	SourceMap SourceMap
}

func Parse

func Parse(source []byte) (Result, error)

func ParseWithLimits

func ParseWithLimits(source []byte, codecLimits Limits, modelLimits requirementsourcemodel.Limits) (Result, error)

type SourceMap

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

func (SourceMap) Location

func (sourceMap SourceMap) Location(pointer string) (Location, bool)

Location resolves a lexical JSON pointer in the admitted wire source. Array indexes describe the caller's source order, not normalized model order.

func (SourceMap) Pointers

func (sourceMap SourceMap) Pointers() []string