Skip to content

[DOC] Document object/array iteration API and numeric Type constants #33

Description

@tazarov

Motivation

While integrating pure-simdjson@v0.1.4, the README and example_test.go were thin on the DOM iteration surface and numeric typing. The following were not easy to pin down without reading element.go directly:

  • Object.Iter() / ObjectIter (Next() / Key() / Value()) and whether iteration is document order (it is — worth stating explicitly, since it affects reproducibility for consumers).
  • Array.Iter() / ArrayIter shape.
  • The full Type() constant set (TypeNull / TypeBool / TypeInt64 / TypeUint64 / TypeFloat64 / TypeString / TypeArray / TypeObject) and the int64-vs-uint64-vs-float classification rules.

Request

A short "Walking the DOM" section in the README (or godoc examples) covering ordered object/array iteration and the numeric type tags. Low effort, high leverage for integrators building parity-sensitive adapters on top of the DOM API.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions