JSONPickleBuilder

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. def areHintsPinned: Boolean

   

   Definition Classes

   PickleTools

5. final def asInstanceOf[T0]: T0

   

   Definition Classes

   Any

6. def beginCollection(length: Int): PBuilder

   

   Denotes that a collection of elements is about to be pickled.

   Denotes that a collection of elements is about to be pickled.

   Note: This must be called after beginEntry()

   length

   The length of the collection being serialized.

   returns

   A pickler which can serialzie the collection.

   Definition Classes

   JSONPickleBuilder → PBuilder

7. def beginEntry(picklee: Any, tag: FastTypeTag[_]): PBuilder

   

   Called to denote that an object is about to be serialized.

   Called to denote that an object is about to be serialized.

   picklee

   The object to be serialized. This may be a primtiive, in which case it can be immediately serialized (or you can wait unitl endEntry is called).

   tag

   The tag to use when pickling this entry. Tags must be serialized/restored, unless otherwise hinted that it can be elided.

   returns

   A pbuilder instance a pickler can use to serialize the picklee, if it's a complex type.

   Definition Classes

   JSONPickleBuilder → PBuilder

8. def clone(): AnyRef

   

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( ... )

9. def endCollection(): Unit

   

   Denote that we are done serializing the collection.

   Denote that we are done serializing the collection.

   Definition Classes

   JSONPickleBuilder → PBuilder

10. def endEntry(): Unit

    

    Call this to denote that the given primitive, collection or structure being pickled is completed.

    Call this to denote that the given primitive, collection or structure being pickled is completed.

    Definition Classes

    JSONPickleBuilder → PBuilder

11. final def eq(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

12. def equals(arg0: Any): Boolean

    

    Definition Classes

    AnyRef → Any

13. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

14. final def getClass(): Class[_]

    

    Definition Classes

    AnyRef → Any

15. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

16. def hintElidedType(tag: FastTypeTag[_]): JSONPickleBuilder.this.type

    

    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.

    Definition Classes

    PickleTools → Hintable

17. def hintKnownSize(knownSize: Int): JSONPickleBuilder.this.type

    

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

    Definition Classes

    PickleTools → Hintable

18. def hintOid(oid: Int): JSONPickleBuilder.this.type

    

    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.

    Definition Classes

    PickleTools → Hintable

19. var hints: List[Hints]

    

    Attributes

    protected

    Definition Classes

    PickleTools

20. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

21. final def ne(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

22. final def notify(): Unit

    

    Definition Classes

    AnyRef

23. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

24. def pinHints(): JSONPickleBuilder.this.type

    

    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.

    Definition Classes

    PickleTools → Hintable

25. def popHints(): JSONPickleBuilder.this.type

    

    Pops to the previously saved set of hints.

    Pops to the previously saved set of hints.

    Definition Classes

    PickleTools → Hintable

26. def pushHints(): JSONPickleBuilder.this.type

    

    Creates a new fresh set of hints, preserving what was hinted before.

    Creates a new fresh set of hints, preserving what was hinted before.

    Definition Classes

    PickleTools → Hintable

27. def putElement(pickler: (PBuilder) ⇒ Unit): PBuilder

    

    Places the next element in the serialized collection.

    Places the next element in the serialized collection.

    Note: This must be called after beginCollection().

    pickler

    A callback which is passed a pickler able to serialize the item in the collection.

    returns

    A pickler which can serialize the next element of the collection.

    Definition Classes

    JSONPickleBuilder → PBuilder

28. def putField(name: String, pickler: (PBuilder) ⇒ Unit): PBuilder

    

    Serialize a "field" in a complex structure/object being pickled.

    Serialize a "field" in a complex structure/object being pickled.

    name

    The name of the field to serialize.

    pickler

    A callback which will be passed an appropriate pickler. You should ensure this function will perform a beginEntry()/endEntry() block.

    returns

    A builder for remaining items in the current complex structure being pickled.

    Definition Classes

    JSONPickleBuilder → PBuilder

29. def result(): JSONPickle

    

    Return the resulting pickle of this builder.

    Return the resulting pickle of this builder.

    Definition Classes

    JSONPickleBuilder → PBuilder

30. final def synchronized[T0](arg0: ⇒ T0): T0

    

    Definition Classes

    AnyRef

31. def toString(): String

    

    Definition Classes

    AnyRef → Any

32. def unpinHints(): JSONPickleBuilder.this.type

    

    Unlocks the hints.

    Unlocks the hints.

    Definition Classes

    PickleTools → Hintable

33. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

34. final def wait(arg0: Long, arg1: Int): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

35. final def wait(arg0: Long): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

36. def withHints[T](body: (Hints) ⇒ T): T

    

    Definition Classes

    PickleTools