jsonpointer

package module

v0.21.0 Latest Latest Go to latest Published: Mar 9, 2024 License: Apache-2.0 Imports: 7 Imported by: 91

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/go-openapi/jsonpointer

Links

Open Source Insights

README ¶

gojsonpointer

An implementation of JSON Pointer - Go language

Status

Completed YES

Tested YES

References

http://tools.ietf.org/html/draft-ietf-appsawg-json-pointer-07

Note

The 4.Evaluation part of the previous reference, starting with 'If the currently referenced value is a JSON array, the reference token MUST contain either...' is not implemented.

Documentation ¶

Index ¶

func Escape(token string) string
func GetForToken(document any, decodedToken string) (any, reflect.Kind, error)
func SetForToken(document any, decodedToken string, value any) (any, error)
func Unescape(token string) string
type JSONPointable
type JSONSetable
type Pointer
- func New(jsonPointerString string) (Pointer, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Escape ¶

func Escape(token string) string

Escape escapes a pointer reference token string

func GetForToken ¶

func GetForToken(document any, decodedToken string) (any, reflect.Kind, error)

GetForToken gets a value for a json pointer token 1 level deep

func SetForToken ¶

func SetForToken(document any, decodedToken string, value any) (any, error)

SetForToken gets a value for a json pointer token 1 level deep

func Unescape ¶

func Unescape(token string) string

Unescape unescapes a json pointer reference token string to the original representation

Types ¶

type JSONPointable ¶

type JSONPointable interface {
	JSONLookup(string) (any, error)
}

JSONPointable is an interface for structs to implement when they need to customize the json pointer process

type JSONSetable ¶

type JSONSetable interface {
	JSONSet(string, any) error
}

JSONSetable is an interface for structs to implement when they need to customize the json pointer process

type Pointer ¶

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

Pointer the json pointer reprsentation

func New ¶

func New(jsonPointerString string) (Pointer, error)

New creates a new json pointer for the given string

func (*Pointer) DecodedTokens ¶

func (p *Pointer) DecodedTokens() []string

DecodedTokens returns the decoded tokens

func (*Pointer) Get ¶

func (p *Pointer) Get(document any) (any, reflect.Kind, error)

Get uses the pointer to retrieve a value from a JSON document

func (*Pointer) IsEmpty ¶

func (p *Pointer) IsEmpty() bool

IsEmpty returns true if this is an empty json pointer this indicates that it points to the root document

func (*Pointer) Offset ¶ added in v0.20.0

func (p *Pointer) Offset(document string) (int64, error)

func (*Pointer) Set ¶

func (p *Pointer) Set(document any, value any) (any, error)

Set uses the pointer to set a value from a JSON document

func (*Pointer) String ¶

func (p *Pointer) String() string

Pointer to string representation function

Source Files ¶

View all Source files

pointer.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL