jsonpointer

package

v0.81.2 Latest Latest Go to latest Published: Jan 18, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation ¶

Package jsonpointer contains RFC 6901 JSON Pointer implementation.

View Source

const DefaultDepthLimit = 1000

DefaultDepthLimit is default depth limit for ResolveCtx.

This section is empty.

func DummyURL() *url.URL

DummyURL is dummy URL for testing purposes.

func Resolve(ptr string, node *yaml.Node) (*yaml.Node, error)

Resolve takes given pointer and returns byte slice of requested value if any. If value not found, returns NotFoundError.

type NotFoundError struct {
	Pointer string
}

NotFoundError reports that requested value is not found.

func (n *NotFoundError) Error() string

Error implements error.

type RefKey struct {
	// Loc is an URL of JSON document.
	Loc string
	// Ptr is JSON Pointer.
	Ptr string
}

RefKey is JSON Reference key.

func (r *RefKey) FromURL(u *url.URL)

FromURL sets RefKey from URL.

func (r RefKey) IsZero() bool

IsZero returns true if RefKey is zero.

func (r RefKey) String() string

String returns string representation of reference.

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

ResolveCtx is JSON Reference resolve context.

func NewResolveCtx(root *url.URL, depthLimit int) *ResolveCtx

NewResolveCtx creates new ResolveCtx.

func (r *ResolveCtx) AddKey(key RefKey, file location.File) error

AddKey adds reference key to context.

func (r *ResolveCtx) Delete(key RefKey)

Delete removes reference from context.

func (r *ResolveCtx) File() (f location.File)

File returns last file from stack.

func (r *ResolveCtx) IsRoot(key RefKey) bool

IsRoot returns true if location stack is empty.

func (r *ResolveCtx) Key(ref string) (key RefKey, _ error)

Key creates new reference key.