Trait

scala.pickling.binary

BinaryPBuilder

Related Doc: package binary

Permalink

trait BinaryPBuilder extends PBuilder

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. BinaryPBuilder
  2. PBuilder
  3. Hintable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def beginCollection(length: Int): PBuilder

    Permalink

    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
    PBuilder
  2. abstract def beginEntry(picklee: Any, tag: FastTypeTag[_]): PBuilder

    Permalink

    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
    PBuilder
  3. abstract def endCollection(): Unit

    Permalink

    Denote that we are done serializing the collection.

    Denote that we are done serializing the collection.

    Definition Classes
    PBuilder
  4. abstract def endEntry(): Unit

    Permalink

    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
    PBuilder
  5. abstract def hintElidedType(tag: FastTypeTag[_]): BinaryPBuilder.this.type

    Permalink

    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
    Hintable
  6. abstract def hintKnownSize(knownSize: Int): BinaryPBuilder.this.type

    Permalink

    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
    Hintable
  7. abstract def hintOid(id: Int): BinaryPBuilder.this.type

    Permalink

    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
    Hintable
  8. abstract def pinHints(): BinaryPBuilder.this.type

    Permalink

    Locks the hints down to what we've specified, so if you drop into anotehr pickler it retains our information.

    Locks the hints down to what we've specified, so if you drop into anotehr pickler it retains our information.

    Definition Classes
    Hintable
  9. abstract def popHints(): BinaryPBuilder.this.type

    Permalink

    Pops to the previously saved set of hints.

    Pops to the previously saved set of hints.

    Definition Classes
    Hintable
  10. abstract def pushHints(): BinaryPBuilder.this.type

    Permalink

    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
    Hintable
  11. abstract def putElement(pickler: (PBuilder) ⇒ Unit): PBuilder

    Permalink

    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
    PBuilder
  12. abstract def putField(name: String, pickler: (PBuilder) ⇒ Unit): PBuilder

    Permalink

    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
    PBuilder
  13. abstract def result(): BinaryPickle

    Permalink

    Return the resulting pickle of this builder.

    Return the resulting pickle of this builder.

    Definition Classes
    BinaryPBuilderPBuilder
  14. abstract def unpinHints(): BinaryPBuilder.this.type

    Permalink

    Unlocks the hints.

    Unlocks the hints.

    Definition Classes
    Hintable

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  10. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  13. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  14. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  15. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  16. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from PBuilder

Inherited from Hintable

Inherited from AnyRef

Inherited from Any

Ungrouped