PReader
Related Doc:
package pickling
returns true if the reader is currently looking at a pickled object/structure.
returns true if the reader is currently looking at a pickled primitive.
Denotes we'd like to read the current entry as a collection.
Denotes we'd like to read the current entry as a collection. Note: Must be called after a beginEntry* call.
Start reading a pickled value.
Start reading a pickled value. This will return any serialized type tag key string. This string can be used to reconstitute a FastTypeTag w/ a mirror, but is intended for use as fast string-matching.
Denote that we are done reading a collection.
Denotes that we're done reading an entry in the pickle.
Hints to the pickle format that we KNOW the type of this field, so it can elide any type hints from the final pickle.
Hints to the pickle format that we KNOW the type of this field, so it can elide any type hints from the final pickle. During unpickling, this informs the format that it shouldn't look for any type hints in the pickle, but instead use this tag as the unpickle tag key.
Hints at the expected (byte) size of the entry we're about to write..
Hints at the expected (byte) size of the entry we're about to write..
Hints the object id of the next beginEntry/endEntry calls.
Hints the object id of the next beginEntry/endEntry calls.
If this oid is -1, it implies that the next entry has not been registered in any sharing cache, and should
be pickled fully. If the oid != -1, then the pickle format is free to elide the fields of the entry in
favor of pickling a scala.pickling.refs.Ref.
Hint: This is only used during pickling.
Locks the hints down to what we've specified, so if you drop into another pickler it retains our information.
Locks the hints down to what we've specified, so if you drop into another pickler it retains our information.
Pops to the previously saved set of hints.
Pops to the previously saved set of hints.
Creates a new fresh set of hints, preserving what was hinted before.
Creates a new fresh set of hints, preserving what was hinted before.
Returns a new Reader that can be used to read the next element in a collection.
Returns a reader which can read a field of a complex structure in the pickle.
Returns a reader which can read a field of a complex structure in the pickle.
The name of the field
A reader which can read the structure's field.
Reads the length of a serialized collection.
Reads the length of a serialized collection. Must be called directly after beginCollection and before readElement.
The length of a serialized collection.
Reads one of the supported primitive types from the pickler.
Unlocks the hints.
Unlocks the hints.
A reader of pickled content. This is a mutable API, intended to be called in certain specific ways.
Here are a few static rules that all picklers must follow when using this interface.
1. There will be one endEntry() for every beginEntry() call. 2. There will be one endCollection() for every beginCollection() call. 3. Every beginCollection()/endCollection() pair will be inside a beginEntry()/endEntry() pair. 4. Every readLength() call will be immediately after a beginCollection() call. 5. Every readElement() call must happen within a beginCollection()/endCollection() block, and after a readLength(). 6. Every readField() call must happen within a beginEntry()/endEntry() block. 7. If readLength() returns 0, there will be no called to readElement(). 8. readField() will only be called where atObject would return true 9. readPrimitive will only be called when atPrimitive would return true 10. The order of readField calls in any pickler will be the exact same ordering when pickling,
Here is a list of all types the auto-generated Picklers considers "primitives" and must be directly supported by any PReader "readPrimitive" operation: