Crate json_event_parser

Source
Expand description

§JSON streaming parser

actions status Latest Version Released API docs

JSON event parser is a simple streaming JSON parser and serializer implementation in Rust.

It does not aims to be the fastest JSON parser possible but to be a simple implementation.

If you want fast and battle-tested code you might prefer to use json, serde_json or simd-json.

Reader example:

use json_event_parser::{FromReadJsonReader, JsonEvent};

let json = b"{\"foo\": 1}";
let mut reader = FromReadJsonReader::new(json.as_slice());
assert_eq!(reader.read_next_event()?, JsonEvent::StartObject);
assert_eq!(reader.read_next_event()?, JsonEvent::ObjectKey("foo".into()));
assert_eq!(reader.read_next_event()?, JsonEvent::Number("1".into()));
assert_eq!(reader.read_next_event()?, JsonEvent::EndObject);
assert_eq!(reader.read_next_event()?, JsonEvent::Eof);

Writer example:

use json_event_parser::{ToWriteJsonWriter, JsonEvent};

let mut writer = ToWriteJsonWriter::new(Vec::new());
writer.write_event(JsonEvent::StartObject)?;
writer.write_event(JsonEvent::ObjectKey("foo".into()))?;
writer.write_event(JsonEvent::Number("1".into()))?;
writer.write_event(JsonEvent::EndObject)?;

assert_eq!(writer.finish()?.as_slice(), b"{\"foo\":1}");

§License

This project is licensed under either of

  • Apache License, Version 2.0, (LICENSE-APACHE or <http://www.apache.org/licenses/LICENSE-2.0>)
  • MIT license (LICENSE-MIT or <http://opensource.org/licenses/MIT>)

at your option.

§Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in json-event-parser by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Structs§

FromBufferJsonReader
Parses a JSON file from a &[u8].
FromReadJsonReader
Parses a JSON file from a Read implementation.
FromTokioAsyncReadJsonReaderasync-tokio
Parses a JSON file from an AsyncRead implementation.
LowLevelJsonReader
A low-level JSON parser acting on a provided buffer.
LowLevelJsonReaderResult
Result of LowLevelJsonReader::read_next_event.
LowLevelJsonWriter
A low-level JSON streaming writer writing to a Write implementation.
SyntaxError
An error in the syntax of the parsed file.
TextPosition
A position in a text i.e. a line number starting from 0, a column number starting from 0 (in number of code points) and a global file offset starting from 0 (in number of bytes).
ToTokioAsyncWriteJsonWriterasync-tokio
A JSON streaming writer writing to an AsyncWrite implementation.
ToWriteJsonWriter
A JSON streaming writer writing to a Write implementation.

Enums§

JsonEvent
Possible events during JSON parsing.
ParseError
A parsing error.