scala.tools.nsc.io

# Pickler

#### abstract class Pickler[T] extends AnyRef

An abstract class for writing and reading Scala objects to and from a legible representation. The presesentation follows the following grammar:

    Pickled = `true` | `false` | `null` | NumericLit | StringLit |
              Labelled | Pickled `,` Pickled
    Labelled = StringLit `(` Pickled? `)`

All ...Lit classes are as in JSON. @see scala.tools.nsc.io.Lexer

Subclasses of `Pickler` each can write and read individual classes of values.

Linear Supertypes
AnyRef, Any
Known Subclasses
CondPickler
Type Hierarchy Learn more about scaladoc diagrams
Ordering

1. Alphabetic
2. By inheritance

Inherited

1. Pickler
2. AnyRef
3. Any

Implicitly

1. by TildeDecorator
2. by any2stringadd
3. by any2stringfmt
4. by any2ArrowAssoc
5. by any2Ensuring

1. Hide All
2. Show all

Learn more about member selection
Visibility

1. Public
2. All

### Instance Constructors

1. #### new Pickler()

### Abstract Value Members

1. #### abstract def pickle(wr: Writer, x: T): Unit

   Writes value in pickled form

   Writes value in pickled form

   wr

     the writer to which pickled form is written

   x

     the value to write

2. #### abstract def unpickle(rd: Lexer): Unpickled[T]

   Reads value from pickled form.

   Reads value from pickled form.

   rd

     the lexer from which lexemes are read

   returns

     An `UnpickleSuccess value if the current input corresponds to the kind of value that is unpickled by the current subclass of` Pickler`, an` UnpickleFailure`value otherwise.`

   Exceptions thrown
     `Lexer.MalformedInput`

     if input is invalid, or if an `Unpickle`

### 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. #### def +(other: String): String

   Implicit information
     This member is added by an implicit conversion from Pickler[T] to StringAdd performed by method any2stringadd in scala.Predef.
   Definition Classes
     StringAdd

5. #### def ->[B](y: B): (Pickler[T], B)

   Implicit information
     This member is added by an implicit conversion from Pickler[T] to ArrowAssoc[Pickler[T]] performed by method any2ArrowAssoc in scala.Predef.
   Definition Classes
     ArrowAssoc
   Annotations
     @inline()

6. #### final def ==(arg0: AnyRef): Boolean

   Definition Classes
     AnyRef

7. #### final def ==(arg0: Any): Boolean

   Definition Classes
     Any

8. #### def asClass[U <: T](c: Class[U]): CondPickler[T]

   A conditional pickler handling values of some Scala class.

   A conditional pickler handling values of some Scala class. It adds the class name as a label to the representation of the current pickler and

   c

     the class of values handled by this pickler.

9. #### final def asInstanceOf[T0]: T0

   Definition Classes
     Any

10. #### def clone(): AnyRef

    Attributes
      protected[java.lang]
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )

11. #### def cond(p: (Any) ⇒ Boolean): CondPickler[T]

    A conditional pickler obtained from the current pickler.

12. #### def ensuring(cond: (Pickler[T]) ⇒ Boolean, msg: ⇒ Any): Pickler[T]

    Implicit information
      This member is added by an implicit conversion from Pickler[T] to Ensuring[Pickler[T]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
      Ensuring

13. #### def ensuring(cond: (Pickler[T]) ⇒ Boolean): Pickler[T]

    Implicit information
      This member is added by an implicit conversion from Pickler[T] to Ensuring[Pickler[T]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
      Ensuring

14. #### def ensuring(cond: Boolean, msg: ⇒ Any): Pickler[T]

    Implicit information
      This member is added by an implicit conversion from Pickler[T] to Ensuring[Pickler[T]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
      Ensuring

15. #### def ensuring(cond: Boolean): Pickler[T]

    Implicit information
      This member is added by an implicit conversion from Pickler[T] to Ensuring[Pickler[T]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
      Ensuring

16. #### final def eq(arg0: AnyRef): Boolean

    Definition Classes
      AnyRef

17. #### def equals(arg0: Any): Boolean

    Definition Classes
      AnyRef → Any

18. #### def finalize(): Unit

    Attributes
      protected[java.lang]
    Definition Classes
      AnyRef
    Annotations
      @throws( classOf[java.lang.Throwable] )

19. #### def formatted(fmtstr: String): String

    Implicit information
      This member is added by an implicit conversion from Pickler[T] to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
      StringFormat
    Annotations
      @inline()

20. #### final def getClass(): Class[_]

    Definition Classes
      AnyRef → Any

21. #### def hashCode(): Int

    Definition Classes
      AnyRef → Any

22. #### final def isInstanceOf[T0]: Boolean

    Definition Classes
      Any

23. #### def labelled(label: String): Pickler[T]

    A pickler that adds a label to the current pickler, using the representation `label ( <current pickler> )`

24. #### final def ne(arg0: AnyRef): Boolean

    Definition Classes
      AnyRef

25. #### final def notify(): Unit

    Definition Classes
      AnyRef

26. #### final def notifyAll(): Unit

    Definition Classes
      AnyRef

27. #### def orNull(implicit fromNull: <:<[Null, T]): Pickler[T]

    A pickler obtained from the current pickler by also admitting `null` as a handled value, represented as the token `null`.

    A pickler obtained from the current pickler by also admitting `null` as a handled value, represented as the token `null`.

    fromNull

      an implicit evidence parameter ensuring that the type of values handled by this pickler contains `null`.

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

    Definition Classes
      AnyRef

29. #### def toString(): String

    Definition Classes
      AnyRef → Any

30. #### final def wait(): Unit

    Definition Classes
      AnyRef
    Annotations
      @throws( ... )

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

    Definition Classes
      AnyRef
    Annotations
      @throws( ... )

32. #### final def wait(arg0: Long): Unit

    Definition Classes
      AnyRef
    Annotations
      @throws( ... )

33. #### def wrapped[U](in: (T) ⇒ U)(out: (U) ⇒ T): Pickler[U]

    A pickler obtained from the current pickler by a pair of transformer functions

    A pickler obtained from the current pickler by a pair of transformer functions

    in

      the function that maps values handled by the current pickler to values handled by the wrapped pickler.

    out

      the function that maps values handled by the wrapped pickler to values handled by the current pickler.

34. #### def ~[U](that: ⇒ Pickler[U]): Pickler[~[T, U]]

    A pickler representing a `~`-pair of values as two consecutive pickled strings, separated by a comma.

    A pickler representing a `~`-pair of values as two consecutive pickled strings, separated by a comma.

    that

      the second pickler which together with the current pickler makes up the pair `this ~ that` to be pickled.

35. #### def →[B](y: B): (Pickler[T], B)

    Implicit information
      This member is added by an implicit conversion from Pickler[T] to ArrowAssoc[Pickler[T]] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
      ArrowAssoc

### Shadowed Implicit Value Members

1. #### val self: Any

   Implicit information
     This member is added by an implicit conversion from Pickler[T] to StringAdd performed by method any2stringadd in scala.Predef.
   Shadowing
     This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
     To access this member you can use a type ascription:

         (pickler: StringAdd).self

   Definition Classes
     StringAdd

2. #### val self: Any

   Implicit information
     This member is added by an implicit conversion from Pickler[T] to StringFormat performed by method any2stringfmt in scala.Predef.
   Shadowing
     This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
     To access this member you can use a type ascription:

         (pickler: StringFormat).self

   Definition Classes
     StringFormat

3. #### def ~[T](y: T): ~[Pickler[T], T]

   Infix method that forms a `~`-pair.

   Infix method that forms a `~`-pair.

   Implicit information
     This member is added by an implicit conversion from Pickler[T] to TildeDecorator[Pickler[T]] performed by method TildeDecorator in scala.tools.nsc.io.Pickler.
   Shadowing
     This implicitly inherited member is shadowed by one or more members in this class.
     To access this member you can use a type ascription:

         (pickler: TildeDecorator[Pickler[T]]).~(y)

   Definition Classes
     TildeDecorator

### Deprecated Value Members

1. #### def x: Pickler[T]

   Implicit information
     This member is added by an implicit conversion from Pickler[T] to ArrowAssoc[Pickler[T]] performed by method any2ArrowAssoc in scala.Predef.
   Shadowing
     This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
     To access this member you can use a type ascription:

         (pickler: ArrowAssoc[Pickler[T]]).x

   Definition Classes
     ArrowAssoc
   Annotations
     @deprecated
   Deprecated

     (Since version 2.10.0) Use `leftOfArrow`instead``

2. #### def x: Pickler[T]

   Implicit information
     This member is added by an implicit conversion from Pickler[T] to Ensuring[Pickler[T]] performed by method any2Ensuring in scala.Predef.
   Shadowing
     This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
     To access this member you can use a type ascription:

         (pickler: Ensuring[Pickler[T]]).x

   Definition Classes
     Ensuring
   Annotations
     @deprecated
   Deprecated

     (Since version 2.10.0) Use `resultOfEnsuring`instead``

### Inherited from AnyRef

### Inherited from Any

### Inherited by implicit conversion TildeDecorator from Pickler[T] to TildeDecorator[Pickler[T]]

### Inherited by implicit conversion any2stringadd from Pickler[T] to StringAdd

### Inherited by implicit conversion any2stringfmt from Pickler[T] to StringFormat

### Inherited by implicit conversion any2ArrowAssoc from Pickler[T] to ArrowAssoc[Pickler[T]]

### Inherited by implicit conversion any2Ensuring from Pickler[T] to Ensuring[Pickler[T]]

### Ungrouped