Type Members

1.  case class AbortJsonProcessingException(msg: String) extends Exception with Product with Serializable

   Throw this inside a Visitor's handler functions to fail the processing of JSON.

   Throw this inside a Visitor's handler functions to fail the processing of JSON. The Facade just needs to provide the error message, and it is up to the driver to ensure it is properly wrapped in a JsonProcessingException with the relevant source information.

2.  trait ArrVisitor[-J, +T] extends ObjArrVisitor[J, T]
3.  final class AsyncParser[J] extends Parser[J] with ByteBasedParser[J]

   AsyncParser is able to parse chunks of data (encoded as Option[ByteBuffer] instances) and parse asynchronously.

   AsyncParser is able to parse chunks of data (encoded as Option[ByteBuffer] instances) and parse asynchronously. You can use the factory methods in the companion object to instantiate an async parser.

   The async parser's fields are described below:

   The (state, curr, stack) triple is used to save and restore parser state between async calls. State also helps encode extra information when streaming or unwrapping an array.

   The (data, len, allocated) triple is used to manage the underlying data the parser is keeping track of. As new data comes in, data may be expanded if not enough space is available.

   The offset parameter is used to drive the outer async parsing. It stores similar information to curr but is kept separate to avoid "corrupting" our snapshot.

   The done parameter is used internally to help figure out when the atEof() parser method should return true. This will be set when apply(None) is called.

   The streamMode parameter controls how the asynchronous parser will be handling multiple values. There are three states:

   1: An array is being unwrapped. Normal JSON array rules apply (Note that if the outer value observed is not an array, this mode will toggle to the -1 mode).

   0: A stream of individual JSON elements separated by whitespace are being parsed. We can return each complete element as we parse it.

   -1: No streaming is occuring. Only a single JSON value is allowed.

4.  class BaseRenderer[T <: Writer] extends Visitor[T, T]
5.  final class ByteArrayParser[J] extends SyncParser[J] with ByteBasedParser[J]

   Basic ByteBuffer parser.

   Basic ByteBuffer parser.

   This assumes that the provided ByteBuffer is ready to be read. The user is responsible for any necessary flipping/resetting of the ByteBuffer before parsing.

   The parser makes absolute calls to the ByteBuffer, which will not update its own mutable position fields.

6.  trait ByteBasedParser[J] extends Parser[J]

   Trait used when the data to be parsed is in UTF-8.

   Trait used when the data to be parsed is in UTF-8.

   This parser has to translate input bytes to Chars and Strings. It provides a byte() method to access individual bytes, and also parser strings from bytes.

   Its parseString() implementation has two cases. In the first case (the hot path) the string has no escape sequences and we can just UTF-8 decode the entire set of bytes. In the second case, it goes to some trouble to be sure to de-escape correctly given that the input data is UTF-8.

7.  final class ByteBufferParser[J] extends SyncParser[J] with ByteBasedParser[J]

   Basic ByteBuffer parser.

   Basic ByteBuffer parser.

   This assumes that the provided ByteBuffer is ready to be read. The user is responsible for any necessary flipping/resetting of the ByteBuffer before parsing.

   The parser makes absolute calls to the ByteBuffer, which will not update its own mutable position fields.

8.  case class BytesRenderer(indent: Int = -1) extends BaseRenderer[BytesWriter] with Product with Serializable
9.  final class ChannelParser[J] extends SyncParser[J] with ByteBasedParser[J]

   Basic file parser.

   Basic file parser.

   Given a file name this parser opens it, chunks the data, and parses it.

10.  trait CharBasedParser[J] extends Parser[J]

    Trait used when the data to be parsed is in UTF-16.

    Trait used when the data to be parsed is in UTF-16.

    This parser provides parseString(). Like ByteBasedParser it has fast/slow paths for string parsing depending on whether any escapes are present.

    It is simpler than ByteBasedParser.

11.  case class IncompleteParseException(msg: String, cause: Throwable) extends Exception with ParsingFailedException with Product with Serializable
12.  sealed trait Js extends Transformable
13.  case class JsonProcessingException(clue: String, index: Int, line: Int, col: Int, path: List[Any], cause: Throwable) extends Exception with Product with Serializable

    Signals failure processsing JSON after parsing.

14.  sealed trait ObjArrVisitor[-J, +T] extends AnyRef

    FContext is used to construct nested JSON values.

    FContext is used to construct nested JSON values.

    The most common cases are to build objects and arrays. However, this type is also used to build a single top-level JSON element, in cases where the entire JSON document consists of "333.33".

15.  trait ObjVisitor[-J, +T] extends ObjArrVisitor[J, T]
16.  case class ParseException(clue: String, index: Int, line: Int, col: Int) extends Exception with ParsingFailedException with Product with Serializable
17.  abstract class Parser[J] extends AnyRef

    Parser implements a state machine for correctly parsing JSON data.

    Parser implements a state machine for correctly parsing JSON data.

    The trait relies on a small number of methods which are left abstract, and which generalize parsing based on whether the input is in Bytes or Chars, coming from Strings, files, or other input. All methods provided here are protected, so different parsers can choose which functionality to expose.

    Parser is parameterized on J, which is the type of the JSON AST it will return. Jawn can produce any AST for which a Facade[J] is available.

    The parser trait does not hold any state itself, but particular implementations will usually hold state. Parser instances should not be reused between parsing runs.

    For now the parser requires input to be in UTF-8. This requirement may eventually be relaxed.

18.  sealed trait ParsingFailedException extends Exception
19.  case class Renderer(out: Writer, indent: Int = -1) extends BaseRenderer[Writer] with Product with Serializable
20.  case class StringRenderer(indent: Int = -1) extends BaseRenderer[StringWriter] with Product with Serializable
21.  abstract class SyncParser[J] extends Parser[J]

    SyncParser extends Parser to do all parsing synchronously.

    SyncParser extends Parser to do all parsing synchronously.

    Most traditional JSON parser are synchronous, and expect to receive all their input before returning. SyncParser[J] still leaves Parser[J]'s methods abstract, but adds a public methods for users to call to actually parse JSON.

22.  abstract class Transformable extends AnyRef
23.  trait Transformer[I] extends AnyRef
24.  trait Visitor[-T, +J] extends AnyRef

    Facade is a type class that describes how Jawn should construct JSON AST elements of type J.

    Facade is a type class that describes how Jawn should construct JSON AST elements of type J.

    Facade[J] also uses FContext[J] instances, so implementors will usually want to define both.