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.
- Alphabetic
- By Inheritance
- AsyncParser
- ByteBasedParser
- Parser
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
val
ARRBEG: Int(6)
Valid parser states.
Valid parser states.
- Attributes
- protected[this]
- Definition Classes
- Parser
-
final
val
ARREND: Int(4)
- Attributes
- protected[this]
- Definition Classes
- Parser
-
final
val
DATA: Int(1)
- Attributes
- protected[this]
- Definition Classes
- Parser
-
final
val
HexChars: Array[Int]
- Attributes
- protected[this]
- Definition Classes
- Parser
-
final
val
KEY: Int(2)
- Attributes
- protected[this]
- Definition Classes
- Parser
-
final
val
KEYVALUE: Int(2)
- Attributes
- protected[this]
- Definition Classes
- Parser
-
final
val
OBJBEG: Int(7)
- Attributes
- protected[this]
- Definition Classes
- Parser
-
final
val
OBJEND: Int(5)
- Attributes
- protected[this]
- Definition Classes
- Parser
-
final
val
SEP: Int(3)
- Attributes
- protected[this]
- Definition Classes
- Parser
- final def absorb(s: String, facade: Visitor[_, J]): Either[ParsingFailedException, Seq[J]]
- final def absorb(bytes: Array[Byte], facade: Visitor[_, J]): Either[ParsingFailedException, Seq[J]]
- final def absorb(buf: ByteBuffer, facade: Visitor[_, J]): Either[ParsingFailedException, Seq[J]]
-
var
allocated: Int
- Attributes
- protected[ujson]
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
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
- AsyncParser → Parser
-
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
- AsyncParser → Parser
-
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
- AsyncParser → Parser
-
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
- AsyncParser → ByteBasedParser
-
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
- AsyncParser → Parser
-
def
churn(facade: Visitor[_, J]): Either[ParsingFailedException, Seq[J]]
- Attributes
- protected[ujson]
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
final
def
close(): Unit
Should be called when parsing is finished.
Should be called when parsing is finished.
- Attributes
- protected[this]
- Definition Classes
- AsyncParser → Parser
-
final
def
column(i: Int): Int
- Attributes
- protected[this]
- Definition Classes
- AsyncParser → Parser
- final def copy(): AsyncParser[J]
-
var
curr: Int
- Attributes
- protected[ujson]
-
var
data: Array[Byte]
- Attributes
- protected[ujson]
-
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
-
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
-
var
done: Boolean
- Attributes
- protected[ujson]
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
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
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
- final def finish(facade: Visitor[_, J]): Either[ParsingFailedException, Seq[J]]
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
var
len: Int
- Attributes
- protected[ujson]
-
var
line: Int
- Attributes
- protected[this]
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
newline(i: Int): Unit
- Attributes
- protected[this]
- Definition Classes
- AsyncParser → Parser
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
var
offset: Int
- Attributes
- protected[ujson]
-
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
-
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
-
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
-
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
-
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
-
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
- ByteBasedParser → Parser
-
final
def
parseStringComplex(i: Int): (String, Int)
- Attributes
- protected[this]
- Definition Classes
- ByteBasedParser
-
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
-
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
-
var
path: List[Any]
- Attributes
- protected[ujson]
-
var
pos: Int
- Attributes
- protected[this]
-
def
reject(j: Int, path: List[Any]): PartialFunction[Throwable, Nothing]
- Definition Classes
- Parser
-
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
- AsyncParser → Parser
-
final
def
resizeIfNecessary(need: Int): Unit
- Attributes
- protected[this]
-
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()
-
var
stack: List[ObjArrVisitor[_, J]]
- Attributes
- protected[ujson]
-
var
state: Int
- Attributes
- protected[ujson]
-
var
streamMode: Int
- Attributes
- protected[ujson]
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
val
utf8: Charset
- Attributes
- protected[this]
- Definition Classes
- Parser
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )