Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use a concrete type for JSON pointer #30

Merged
merged 1 commit into from
Apr 18, 2024
Merged

Use a concrete type for JSON pointer #30

merged 1 commit into from
Apr 18, 2024

Conversation

dsnet
Copy link
Collaborator

@dsnet dsnet commented Apr 12, 2024

WARNING: This commit includes breaking changes.

Declare a jsontext.Pointer type as a named string type.

This allows us to implement a Tokens method to conveniently iterate over all the reference tokens in the pointer using the upcoming iterators support.

The new functionally is currently not tested by CI, but can be manually tested with:

GOEXPERIMENT=rangefunc go.tip test ./...

Copy link
Collaborator

@johanbrandhorst johanbrandhorst left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Super cool. Are we looking to implement iterators anywhere else?

@dsnet
Copy link
Collaborator Author

dsnet commented Apr 12, 2024

I can imagine the following:

func (*Encoder) WriteTokens(seq iter.Seq2[Token, error]) error
func (*Decoder) ReadTokens() iter.Seq2[Token, error]

but that can be future API.

jsontext/pointer.go Outdated Show resolved Hide resolved
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

//go:build goexperiment.rangefunc
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

at this point I would personally use //go:build go1.23 and test with Go master or the first pre-release once it's out, which should be soon. Ideally we would use goexperiment.rangefunc || 1.23, but that's broken because of golang/go#66399. With your build tag as is, any 1.23 users can't see this API, which isn't right.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

At present, the iter package has the goexperiment.rangefunc tag, so go1.23 isn't enough. It's not clear to me whether the intent is to have iterators be directly supported in Go 1.23. For now I'll submit it with the current tag and we can adjust it accordingly based on what happens upstream.

WARNING: This commit includes breaking changes.

Declare a jsontext.Pointer type as a named string type.

This allows us to implement a Tokens method to conveniently
iterate over all the reference tokens in the pointer
using the upcoming iterators support.

The new functionally is currently not tested by CI,
but can be manually tested with:

	GOEXPERIMENT=rangefunc go.tip test ./...
@dsnet dsnet merged commit af2d506 into master Apr 18, 2024
8 checks passed
@dsnet dsnet deleted the jsontextpointer branch April 18, 2024 18:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants