scala.pickling

Hintable

trait Hintable extends AnyRef

Hintable defines the interface used between picklers and formats to "aide' in creating clean/efficient formats.

The FULL features picklers allow: - eliding statically known types - structural sharing of data - possible binary size optimizations (using jvm sizes)

Obviously not all picklers will use these mechanisms.


Size Optimization

If a pickler/unpickler calls hintKnownSize, it's talking about a binary size of the following entry. ----

Type Optimization

If a pickler/unpickler call hintElidedType, it's allowing the underlying format to 'drop' the forced storage of a type tag. ----

Structural Sharing

If a pickler/unpickler calls hintOid, it's telling the underlying format that this particular pickler entry shares it structure with the same entry of that number.

Currently, rather than using known tags, picklers assume a per-pickle ordinal associated with each entry. This ordinal should be automatically tracked and restored.

Linear Supertypes
AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hintable
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def hintElidedType(tag: FastTypeTag[_]): Hintable.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.

  2. abstract def hintKnownSize(knownSize: Int): Hintable.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..

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

  4. abstract def pinHints(): Hintable.this.type

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

  5. abstract def popHints(): Hintable.this.type

    Pops to the previously saved set of hints.

  6. abstract def pushHints(): Hintable.this.type

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

  7. abstract def unpinHints(): Hintable.this.type

    Unlocks the hints.

Concrete Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

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

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. def clone(): AnyRef

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

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

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

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

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

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

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

    Definition Classes
    AnyRef
  15. final def notify(): Unit

    Definition Classes
    AnyRef
  16. final def notifyAll(): Unit

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

    Definition Classes
    AnyRef
  18. def toString(): String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped