jsonpointer

Documentation

Overview

Package jsonpointer contains RFC 6901 JSON Pointer implementation.

Index

• Constants
• func Resolve(ptr string, node *yaml.Node) (*yaml.Node, error)
• type NotFoundError
  • func (n *NotFoundError) Error() string
• type RefKey
  • func (r *RefKey) FromURL(u *url.URL)
• type ResolveCtx
  • func DefaultCtx() *ResolveCtx
  • func NewResolveCtx(depthLimit int) *ResolveCtx
  • func (r *ResolveCtx) Add(ref string) (key RefKey, err error)
  • func (r *ResolveCtx) AddKey(key RefKey) error
  • func (r *ResolveCtx) Delete(key RefKey)
  • func (r *ResolveCtx) Key(ref string) (key RefKey, _ error)
  • func (r *ResolveCtx) LastLoc() string

Constants

const DefaultDepthLimit = 1000

DefaultDepthLimit is default depth limit for ResolveCtx.

Functions

func Resolve

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.

Types

type NotFoundError

type NotFoundError struct {
	Pointer string
}

NotFoundError reports that requested value is not found.

func (*NotFoundError) Error

func (n *NotFoundError) Error() string

Error implements error.

type RefKey

type RefKey struct {
	Loc string
	Ref string
}

RefKey is JSON reference key.

func (*RefKey) FromURL

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

FromURL sets RefKey from URL.

type ResolveCtx

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

ResolveCtx is JSON pointer resolve context.

func DefaultCtx

func DefaultCtx() *ResolveCtx

DefaultCtx creates new ResolveCtx with default depth limit.

func NewResolveCtx

func NewResolveCtx(depthLimit int) *ResolveCtx

NewResolveCtx creates new ResolveCtx.

func (*ResolveCtx) Add

func (r *ResolveCtx) Add(ref string) (key RefKey, err error)

Add adds reference to context and returns key.

func (*ResolveCtx) AddKey

func (r *ResolveCtx) AddKey(key RefKey) error

AddKey adds reference key to context.

func (*ResolveCtx) Delete

func (r *ResolveCtx) Delete(key RefKey)

Delete removes reference from context.

func (*ResolveCtx) Key

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

Key creates new reference key.

func (*ResolveCtx) LastLoc

func (r *ResolveCtx) LastLoc() string

LastLoc returns last location from stack.