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. 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.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AsyncParser
  2. ByteBasedParser
  3. Parser
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new AsyncParser(state: Int, curr: Int, stack: List[ObjArrVisitor[_, J]], path: List[Any], data: Array[Byte], len: Int, allocated: Int, offset: Int, done: Boolean, streamMode: Int)
    Attributes
    protected[ujson]

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final val ARRBEG: Int(6)

    Valid parser states.

    Valid parser states.

    Attributes
    protected[this]
    Definition Classes
    Parser
  5. final val ARREND: Int(4)
    Attributes
    protected[this]
    Definition Classes
    Parser
  6. final val DATA: Int(1)
    Attributes
    protected[this]
    Definition Classes
    Parser
  7. final val HexChars: Array[Int]
    Attributes
    protected[this]
    Definition Classes
    Parser
  8. final val KEY: Int(2)
    Attributes
    protected[this]
    Definition Classes
    Parser
  9. final val KEYVALUE: Int(2)
    Attributes
    protected[this]
    Definition Classes
    Parser
  10. final val OBJBEG: Int(7)
    Attributes
    protected[this]
    Definition Classes
    Parser
  11. final val OBJEND: Int(5)
    Attributes
    protected[this]
    Definition Classes
    Parser
  12. final val SEP: Int(3)
    Attributes
    protected[this]
    Definition Classes
    Parser
  13. final def absorb(s: String, facade: Visitor[_, J]): Either[ParsingFailedException, Seq[J]]
  14. final def absorb(bytes: Array[Byte], facade: Visitor[_, J]): Either[ParsingFailedException, Seq[J]]
  15. final def absorb(buf: ByteBuffer, facade: Visitor[_, J]): Either[ParsingFailedException, Seq[J]]
  16. var allocated: Int
    Attributes
    protected[ujson]
  17. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  18. final def at(i: Int, k: Int): CharSequence

    Access a byte range as a string.

    Access a byte range as a string.

    Since the underlying data are UTF-8 encoded, i and k must occur on unicode boundaries. Also, the resulting String is not guaranteed to have length (k - i).

    Attributes
    protected[this]
    Definition Classes
    AsyncParserParser
  19. final def at(i: Int): Char

    Read the byte/char at 'i' as a Char.

    Read the byte/char at 'i' as a Char.

    Note that this should not be used on potential multi-byte sequences.

    Attributes
    protected[this]
    Definition Classes
    AsyncParserParser
  20. final def atEof(i: Int): Boolean

    Return true iff 'i' is at or beyond the end of the input (EOF).

    Return true iff 'i' is at or beyond the end of the input (EOF).

    Attributes
    protected[this]
    Definition Classes
    AsyncParserParser
  21. final def byte(i: Int): Byte

    This is a specialized accessor for the case where our underlying data are bytes not chars.

    This is a specialized accessor for the case where our underlying data are bytes not chars.

    Attributes
    protected[this]
    Definition Classes
    AsyncParserByteBasedParser
  22. final def checkpoint(state: Int, i: Int, stack: List[ObjArrVisitor[_, J]], path: List[Any]): Unit

    We use this to keep track of the last recoverable place we've seen.

    We use this to keep track of the last recoverable place we've seen. If we hit an AsyncException, we can later resume from this point.

    This method is called during every loop of rparse, and the arguments are the exact arguments we can pass to rparse to continue where we left off.

    Attributes
    protected[this]
    Definition Classes
    AsyncParserParser
  23. def churn(facade: Visitor[_, J]): Either[ParsingFailedException, Seq[J]]
    Attributes
    protected[ujson]
  24. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate() @throws( ... )
  25. final def close(): Unit

    Should be called when parsing is finished.

    Should be called when parsing is finished.

    Attributes
    protected[this]
    Definition Classes
    AsyncParserParser
  26. final def column(i: Int): Int
    Attributes
    protected[this]
    Definition Classes
    AsyncParserParser
  27. final def copy(): AsyncParser[J]
  28. var curr: Int
    Attributes
    protected[ujson]
  29. var data: Array[Byte]
    Attributes
    protected[ujson]
  30. final def descape(s: CharSequence): Char

    Generate a Char from the hex digits of "ሴ" (i.e.

    Generate a Char from the hex digits of "ሴ" (i.e. "1234").

    NOTE: This is only capable of generating characters from the basic plane. This is why it can only return Char instead of Int.

    Attributes
    protected[this]
    Definition Classes
    Parser
  31. def die(i: Int, msg: String): Nothing

    Used to generate error messages with character info and offsets.

    Used to generate error messages with character info and offsets.

    Attributes
    protected[this]
    Definition Classes
    Parser
  32. var done: Boolean
    Attributes
    protected[ujson]
  33. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  34. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  35. def error(msg: String): Nothing

    Used to generate messages for internal errors.

    Used to generate messages for internal errors.

    This should only be used in situations where a possible bug in the parser was detected. For errors in user-provided JSON, use die().

    Attributes
    protected[this]
    Definition Classes
    Parser
  36. final def finish(facade: Visitor[_, J]): Either[ParsingFailedException, Seq[J]]
  37. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  38. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  39. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  40. var len: Int
    Attributes
    protected[ujson]
  41. var line: Int
    Attributes
    protected[this]
  42. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  43. final def newline(i: Int): Unit
    Attributes
    protected[this]
    Definition Classes
    AsyncParserParser
  44. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  45. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  46. var offset: Int
    Attributes
    protected[ujson]
  47. final def parse(i: Int, facade: Visitor[_, J]): (J, Int)

    Parse and return the next JSON value and the position beyond it.

    Parse and return the next JSON value and the position beyond it.

    Attributes
    protected[this]
    Definition Classes
    Parser
  48. final def parseFalse(i: Int, facade: Visitor[_, J]): J

    Parse the JSON constant "false".

    Parse the JSON constant "false".

    Note that this method assumes that the first character has already been checked.

    Attributes
    protected[this]
    Definition Classes
    Parser
  49. final def parseNull(i: Int, facade: Visitor[_, J]): J

    Parse the JSON constant "null".

    Parse the JSON constant "null".

    Note that this method assumes that the first character has already been checked.

    Attributes
    protected[this]
    Definition Classes
    Parser
  50. final def parseNum(i: Int, ctxt: ObjArrVisitor[Any, J], facade: Visitor[_, J]): Int

    Parse the given number, and add it to the given context.

    Parse the given number, and add it to the given context.

    We don't actually instantiate a number here, but rather pass the string of for future use. Facades can choose to be lazy and just store the string. This ends up being way faster and has the nice side-effect that we know exactly how the user represented the number.

    Attributes
    protected[this]
    Definition Classes
    Parser
  51. final def parseNumSlow(i: Int, facade: Visitor[_, J]): (J, Int)

    Parse the given number, and add it to the given context.

    Parse the given number, and add it to the given context.

    This method is a bit slower than parseNum() because it has to be sure it doesn't run off the end of the input.

    Normally (when operating in rparse in the context of an outer array or object) we don't need to worry about this and can just grab characters, because if we run out of characters that would indicate bad input. This is for cases where the number could possibly be followed by a valid EOF.

    This method has all the same caveats as the previous method.

    Attributes
    protected[this]
    Definition Classes
    Parser
  52. final def parseString(i: Int, key: Boolean): (CharSequence, Int)

    Parse the string according to JSON rules, and add to the given context.

    Parse the string according to JSON rules, and add to the given context.

    This method expects the data to be in UTF-8 and accesses it as bytes.

    Attributes
    protected[this]
    Definition Classes
    ByteBasedParserParser
  53. final def parseStringComplex(i: Int): (String, Int)
    Attributes
    protected[this]
    Definition Classes
    ByteBasedParser
  54. final def parseStringSimple(i: Int): Int

    See if the string has any escape sequences.

    See if the string has any escape sequences. If not, return the end of the string. If so, bail out and return -1.

    This method expects the data to be in UTF-8 and accesses it as bytes. Thus we can just ignore any bytes with the highest bit set.

    Attributes
    protected[this]
    Definition Classes
    ByteBasedParser
  55. final def parseTrue(i: Int, facade: Visitor[_, J]): J

    Parse the JSON constant "true".

    Parse the JSON constant "true".

    Note that this method assumes that the first character has already been checked.

    Attributes
    protected[this]
    Definition Classes
    Parser
  56. var path: List[Any]
    Attributes
    protected[ujson]
  57. var pos: Int
    Attributes
    protected[this]
  58. def reject(j: Int, path: List[Any]): PartialFunction[Throwable, Nothing]
    Definition Classes
    Parser
  59. final def reset(i: Int): Int

    The reset() method is used to signal that we're working from the given position, and any previous data can be released.

    The reset() method is used to signal that we're working from the given position, and any previous data can be released. Some parsers (e.g. StringParser) will ignore release, while others (e.g. PathParser) will need to use this information to release and allocate different areas.

    Attributes
    protected[this]
    Definition Classes
    AsyncParserParser
  60. final def resizeIfNecessary(need: Int): Unit
    Attributes
    protected[this]
  61. final def rparse(state: Int, j: Int, stack: List[ObjArrVisitor[_, J]], path: List[Any]): (J, Int)

    Tail-recursive parsing method to do the bulk of JSON parsing.

    Tail-recursive parsing method to do the bulk of JSON parsing.

    This single method manages parser states, data, etc. Except for parsing non-recursive values (like strings, numbers, and constants) all important work happens in this loop (or in methods it calls, like reset()).

    Currently the code is optimized to make use of switch statements. Future work should consider whether this is better or worse than manually constructed if/else statements or something else. Also, it may be possible to reorder some cases for speed improvements.

    j

    index/position in the source json

    path

    the json path in the tree

    Attributes
    protected[this]
    Definition Classes
    Parser
    Annotations
    @tailrec()
  62. var stack: List[ObjArrVisitor[_, J]]
    Attributes
    protected[ujson]
  63. var state: Int
    Attributes
    protected[ujson]
  64. var streamMode: Int
    Attributes
    protected[ujson]
  65. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  66. def toString(): String
    Definition Classes
    AnyRef → Any
  67. final val utf8: Charset
    Attributes
    protected[this]
    Definition Classes
    Parser
  68. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  69. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  70. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from ByteBasedParser[J]

Inherited from Parser[J]

Inherited from AnyRef

Inherited from Any

Ungrouped