parse

func (*Parser) Consumed ¶

func (p *Parser) Consumed() []shared.FieldError

Consumed checks the Parser has used all of the changes. It adds an error for any unparsed changes.

func (*Parser) Each ¶

func (p *Parser) Each(fn func(int, *Parser) []shared.FieldError, required ...int) *Parser

Each will run fn with a Parser for any indexed keys. If required is specified then those indexes must exist.

Consider the changes:

{"key": "/0/thing", "old": null, "new": "a string"}
{"key": "/1/thing", "old": null, "new": "another string"}

Then to parse to a list of strings s do:

parser.Each(func(i int, p *Parser) {
	var v string
	p.Field("/thing", v)
	s = append(s, v)
	return p.Consumed()
})

func (*Parser) Errors ¶

func (p *Parser) Errors() []shared.FieldError

Errors returns the current error list for the Parser.

func (*Parser) Field ¶

func (p *Parser) Field(key string, existing any, opts ...Option) *Parser

Field will JSON unmarshal the specified key into existing. It will add an error if the key does not exist.

Consider the change:

{"key": "/thing", "old": null, "new": "a string"}

Then to parse to a string s do:

parser.Field("/thing", &s)

func (*Parser) OutOfRange ¶

func (p *Parser) OutOfRange() []shared.FieldError

OutOfRange can be used with Parser.Each when the index is not in an expected range. It adds an out of range error for all changes.

func (*Parser) Prefix ¶

func (p *Parser) Prefix(prefix string, fn func(*Parser) []shared.FieldError, opts ...Option) *Parser

Prefix will run fn with a Parser of any changes with the specified prefix. It will add an error if the prefix does not exist.

Consider the changes:

{"key": "/thing/name", "old": null, "new": "a string"}
{"key": "/thing/size", "old": null, "new": 5}

Then to parse to a Thing t do:

parser.Prefix("/thing", func(p *Parser) {
	return p.
		Field("/name", &t.Name).
		Field("/size", &t.Size).
		Consumed()
})