Skip to content

feat: Streaming JSON Parsing API #8

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.

Sign up for GitHub

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

Open
vnixx wants to merge 4 commits into
base: main
Choose a base branch
from
Open

feat: Streaming JSON Parsing API #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f4029b5
feat: add streaming JSON parsing API
vnixx Apr 25, 2026
1f65dae
fix: tighten streaming array parsing
vnixx May 8, 2026
1b769b9
fix(streaming): correctness, perf, and thread-safety fixes after review
vnixx May 22, 2026
9f7de5b
fix(streaming): avoid Optional<~Copyable> in feed() for Linux Swift 5.10
vnixx May 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion Sources/ReerJSON/Error.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,17 +51,27 @@ public struct JSONError: Error, Equatable, Sendable, CustomStringConvertible {
/// The coding path where the error occurred (for decoding errors).
public let path: String

/// The underlying yyjson read error code, when this error originates from
/// the JSON parser. Zero (`YYJSON_READ_SUCCESS`) when not applicable.
///
/// This is primarily used by the streaming APIs to distinguish recoverable
/// "need more data" conditions (`YYJSON_READ_ERROR_UNEXPECTED_END`,
/// `YYJSON_READ_ERROR_EMPTY_CONTENT`, `YYJSON_READ_ERROR_MORE`) from
/// non-recoverable parse errors.
internal let readErrorCode: UInt32

public var description: String {
if path.isEmpty {
return message
}
return "\(message) (at \(path))"
}

private init(kind: Kind, message: String, path: String = "") {
private init(kind: Kind, message: String, path: String = "", readErrorCode: UInt32 = 0) {
self.kind = kind
self.message = message
self.path = path
self.readErrorCode = readErrorCode
}

// MARK: - Public Factory Methods
Expand Down Expand Up @@ -144,6 +154,7 @@ public struct JSONError: Error, Equatable, Sendable, CustomStringConvertible {
self.kind = .invalidJSON
self.message = message
self.path = ""
self.readErrorCode = UInt32(error.code)
}

/// Create an error from a yyjson write error.
Expand All @@ -168,5 +179,6 @@ public struct JSONError: Error, Equatable, Sendable, CustomStringConvertible {
self.kind = .writeError
self.message = message
self.path = ""
self.readErrorCode = 0
}
}
Loading