github.com/json-iterator/go v1.1.11: jsoniter.NewIterator

Clean-room public code sample — generation instructions

Write a brand-new, minimal, self-contained code sample in this clean-room directory.
Do not copy, paraphrase, or reference any existing project source. Work only from this spec.

A csx.json manifest scaffold already exists. Do not recreate it from memory. Preserve its case.goal, packages and symbols; fill its empty case.contract with exact assertions and correct its environment, commands and verifierAdapter for the files you generate.

Goal: verify jsoniter.NewIterator in pkg:golang/github.com/json-iterator/go@v1.1.11
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:golang/github.com/json-iterator/go@v1.1.11
Demonstrate these symbols/APIs:
  - jsoniter.NewIterator

Rules:
  - One focused purpose; the smallest project that proves the goal.
  - Include a contract test (test/contract.*) that runs OFFLINE and exits 0 exactly when the goal behavior works.
  - Pin every dependency with a lockfile so resolution is reproducible.
  - No secrets, credentials, or tokens. No real URLs (only example.com or localhost). No absolute paths.
  - No personal names, emails, company names, or project identifiers of any kind.
  - No binaries and no generated output (node_modules, dist, target, venv, .git, .env).
  - Keep it under 200 files and 256KB packed.

{"case":{"caseId":"case:sha256:14a75fb7ae86ff35ef6a98c7794417b50c8dbcf1f89b30e9e82f1519e83da572","contract":["jsoniter.NewIterator creates an empty Iterator instance configured with the specified API configuration","jsoniter.NewIterator parses JSON objects, primitive fields, arrays, and detects element value types after buffer initialization with ResetBytes","jsoniter.NewIterator supports buffer reuse across multiple inputs and records error state upon encountering malformed JSON syntax"],"goal":"verify jsoniter.NewIterator in pkg:golang/github.com/json-iterator/go@v1.1.11","kind":"HOW","packages":["pkg:golang/github.com/json-iterator/go@v1.1.11"],"schemaVersion":1,"symbols":["jsoniter.NewIterator"]},"contractCommand":["go","run","./test"],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"golang","libc":"glibc","libcVersion":"2.39","os":"linux","osVersionBucket":"24","packageManager":"go","schemaVersion":1},"license":"MIT-0","packages":["pkg:golang/github.com/json-iterator/go@v1.1.11"],"schemaVersion":1,"subject":"pkg:golang/github.com/json-iterator/go@v1.1.11","symbols":["jsoniter.NewIterator"],"verifierAdapter":"golang@1"}

module example.com/jsoniter-iterator

go 1.26.6

require github.com/json-iterator/go v1.1.11

require (
	github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421 // indirect
	github.com/modern-go/reflect2 v0.0.0-20180701023420-4b7aa43c6742 // indirect
)

github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/google/gofuzz v1.0.0/go.mod h1:dBl0BpW6vV/+mYPU4Po3pmUjxk6FQPldtuIdl/M65Eg=
github.com/json-iterator/go v1.1.11 h1:uVUAXhF2To8cbw/3xN3pxj6kk7TYKs98NIrTqPlMWAQ=
github.com/json-iterator/go v1.1.11/go.mod h1:KdQUCv79m/52Kvf8AW2vK1V8akMuk1QjK/uOdHXbAo4=
github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421 h1:ZqeYNhU3OHLH3mGKHDcjJRFFRrJa6eAM5H+CtDdOsPc=
github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q=
github.com/modern-go/reflect2 v0.0.0-20180701023420-4b7aa43c6742 h1:Esafd1046DLDQ0W1YjYsBW+p8U2u7vzgW2SQVmlNazg=
github.com/modern-go/reflect2 v0.0.0-20180701023420-4b7aa43c6742/go.mod h1:bx2lNnkwVCuqBIxFjflWJWanXIb3RllmbCylyMrvgv0=
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
github.com/stretchr/testify v1.3.0 h1:TivCn/peBQ7UY8ooIcPgZFpTNSz0Q2U6UrFlUfqbe0Q=
github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=

package jsoniteriterator

import (
	jsoniter "github.com/json-iterator/go"
)

// Record represents structured data parsed by Iterator.
type Record struct {
	ID       int
	Title    string
	Score    float64
	Verified bool
	Tags     []string
}

// ParseRecord uses jsoniter.NewIterator to parse a JSON byte slice into a Record.
func ParseRecord(data []byte) (*Record, error) {
	iter := jsoniter.NewIterator(jsoniter.ConfigDefault)
	iter.ResetBytes(data)

	rec := &Record{}
	for field := iter.ReadObject(); field != ""; field = iter.ReadObject() {
		switch field {
		case "id":
			rec.ID = iter.ReadInt()
		case "title":
			rec.Title = iter.ReadString()
		case "score":
			rec.Score = iter.ReadFloat64()
		case "verified":
			rec.Verified = iter.ReadBool()
		case "tags":
			for iter.ReadArray() {
				rec.Tags = append(rec.Tags, iter.ReadString())
			}
		default:
			iter.Skip()
		}
	}

	if iter.Error != nil {
		return nil, iter.Error
	}
	return rec, nil
}

{
  "schemaVersion": 1,
  "goal": "verify jsoniter.NewIterator in pkg:golang/github.com/json-iterator/go@v1.1.11",
  "kind": "HOW",
  "packages": [
    "pkg:golang/github.com/json-iterator/go@v1.1.11"
  ],
  "symbols": [
    "jsoniter.NewIterator"
  ]
}

package main

import (
	"fmt"
	"os"

	jsoniteriterator "example.com/jsoniter-iterator"
	jsoniter "github.com/json-iterator/go"
)

func main() {
	// Contract 1: jsoniter.NewIterator creates an empty Iterator instance configured with the specified API configuration
	iter := jsoniter.NewIterator(jsoniter.ConfigDefault)
	if iter == nil {
		fmt.Fprintln(os.Stderr, "FAIL: NewIterator returned nil")
		os.Exit(1)
	}
	if iter.Pool() == nil {
		fmt.Fprintln(os.Stderr, "FAIL: Iterator Pool should not be nil")
		os.Exit(1)
	}

	// Contract 2: jsoniter.NewIterator parses JSON objects, primitive fields, arrays, and detects element value types after buffer initialization with ResetBytes
	payload := []byte(`{"id":101,"title":"sample","score":98.5,"verified":true,"tags":["csx","go"]}`)
	rec, err := jsoniteriterator.ParseRecord(payload)
	if err != nil {
		fmt.Fprintf(os.Stderr, "FAIL: ParseRecord failed: %v\n", err)
		os.Exit(1)
	}
	if rec.ID != 101 || rec.Title != "sample" || rec.Score != 98.5 || !rec.Verified || len(rec.Tags) != 2 || rec.Tags[0] != "csx" || rec.Tags[1] != "go" {
		fmt.Fprintf(os.Stderr, "FAIL: parsed record values mismatch: %+v\n", rec)
		os.Exit(1)
	}

	// Direct verification of WhatIsNext with NewIterator and ResetBytes
	iter.ResetBytes([]byte(`{"k":"v"}`))
	if iter.WhatIsNext() != jsoniter.ObjectValue {
		fmt.Fprintf(os.Stderr, "FAIL: WhatIsNext expected ObjectValue, got %v\n", iter.WhatIsNext())
		os.Exit(1)
	}

	iter.ResetBytes([]byte(`[1, 2]`))
	if iter.WhatIsNext() != jsoniter.ArrayValue {
		fmt.Fprintf(os.Stderr, "FAIL: WhatIsNext expected ArrayValue, got %v\n", iter.WhatIsNext())
		os.Exit(1)
	}

	// Contract 3: jsoniter.NewIterator supports buffer reuse across multiple inputs and records error state upon encountering malformed JSON syntax
	iter.ResetBytes([]byte(`"hello world"`))
	str := iter.ReadString()
	if iter.Error != nil || str != "hello world" {
		fmt.Fprintf(os.Stderr, "FAIL: string read failed: %v, got %s\n", iter.Error, str)
		os.Exit(1)
	}

	// Syntax error detection
	iter.ResetBytes([]byte(`{invalid-json}`))
	_ = iter.ReadObject()
	if iter.Error == nil {
		fmt.Fprintln(os.Stderr, "FAIL: expected syntax error on invalid JSON, got nil")
		os.Exit(1)
	}

	_, malformedErr := jsoniteriterator.ParseRecord([]byte(`{"id": not_a_number}`))
	if malformedErr == nil {
		fmt.Fprintln(os.Stderr, "FAIL: expected error when parsing malformed record, got nil")
		os.Exit(1)
	}

	fmt.Println("PASS: jsoniter.NewIterator contract validated")
}