upickle.implicits

Members list

Packages

Type members

Classlikes

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait CaseClassReadWriters extends Types

Basic functionality to be able to read and write objects. Kept as a trait so other internal files can use it, while also mixing it into the upickle package to form the public API1

Basic functionality to be able to read and write objects. Kept as a trait so other internal files can use it, while also mixing it into the upickle package to form the public API1

Attributes

Supertypes
trait Types
class Object
trait Matchable
class Any
Known subtypes
Self type
Config
abstract class CaseObjectContext[V](fieldCount: Int) extends ObjVisitor[Any, V], BaseCaseObjectContext

Attributes

Supertypes
trait ObjVisitor[Any, V]
trait ObjArrVisitor[Any, V]
class Object
trait Matchable
class Any
Show all
trait Generated extends TupleReadWriters

Auto-generated picklers and unpicklers, used for creating the 22 versions of tuple-picklers and case-class picklers

Auto-generated picklers and unpicklers, used for creating the 22 versions of tuple-picklers and case-class picklers

Attributes

Supertypes
trait Types
class Object
trait Matchable
class Any
Known subtypes
trait Readers
trait Writers
Self type
Config
abstract class HugeCaseObjectContext[V](fieldCount: Int) extends ObjVisitor[Any, V], BaseCaseObjectContext

Attributes

Supertypes
trait ObjVisitor[Any, V]
trait ObjArrVisitor[Any, V]
class Object
trait Matchable
class Any
Show all
trait LowPriWriters extends Types

This needs to be split into a separate trait due to https://github.com/scala/bug/issues/11768

This needs to be split into a separate trait due to https://github.com/scala/bug/issues/11768

Attributes

Supertypes
trait Types
class Object
trait Matchable
class Any
Known subtypes
trait Writers
Self type
Config
trait MacroImplicits extends Readers, Writers, Annotator

Attributes

Supertypes
trait Writers
trait Readers
trait Annotator
trait MacrosCommon
trait Config
trait Generated
trait Types
class Object
trait Matchable
class Any
Show all
Self type
Types
trait MacrosCommon extends Config, Types

Attributes

Companion
object
Supertypes
trait Types
trait Config
class Object
trait Matchable
class Any
Known subtypes
object MacrosCommon

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type

Attributes

Supertypes
trait Annotator
trait MacrosCommon
trait Config
trait Generated
trait Types
class Object
trait Matchable
class Any
Show all
Known subtypes
Self type
Annotator
trait ReadersVersionSpecific extends MacrosCommon, Types, Annotator, CaseClassReadWriters

Attributes

Supertypes
trait Annotator
trait MacrosCommon
trait Types
trait Config
class Object
trait Matchable
class Any
Show all
Known subtypes
trait Readers
trait TupleReadWriters extends Types

Basic functionality to be able to read and write objects. Kept as a trait so other internal files can use it, while also mixing it into the upickle package to form the public API1

Basic functionality to be able to read and write objects. Kept as a trait so other internal files can use it, while also mixing it into the upickle package to form the public API1

Attributes

Supertypes
trait Types
class Object
trait Matchable
class Any
Known subtypes
trait Generated
trait Readers
trait Writers
Self type
Config

Attributes

Supertypes
trait Annotator
trait MacrosCommon
trait Config
trait Generated
trait Types
class Object
trait Matchable
class Any
Show all
Known subtypes
Self type
Annotator
trait WritersVersionSpecific extends MacrosCommon, Types, Annotator, CaseClassReadWriters

Attributes

Supertypes
trait Annotator
trait MacrosCommon
trait Types
trait Config
class Object
trait Matchable
class Any
Show all
Known subtypes
trait Writers
class allowUnknownKeys(b: Boolean) extends StaticAnnotation

Annotation for fine-grained control of the def allowUnknownKeys configuration on the upickle bundle; can be applied to individual case classes, taking precedence over upickle pickler-level configuration

Annotation for fine-grained control of the def allowUnknownKeys configuration on the upickle bundle; can be applied to individual case classes, taking precedence over upickle pickler-level configuration

Attributes

Supertypes
trait StaticAnnotation
class Annotation
class Object
trait Matchable
class Any
class flatten extends StaticAnnotation

An annotation that, when applied to a field in a case class, flattens the fields of the annotated case class or Iterable into the parent case class during serialization. This means the fields will appear at the same level as the parent case class's fields rather than nested under the field name. During deserialization, these fields are grouped back into the annotated case class or Iterable.

An annotation that, when applied to a field in a case class, flattens the fields of the annotated case class or Iterable into the parent case class during serialization. This means the fields will appear at the same level as the parent case class's fields rather than nested under the field name. During deserialization, these fields are grouped back into the annotated case class or Iterable.

Limitations:

  • Only works with collections type that are subtypes of Iterable[(String, _)].
  • Cannot flatten more than two collections in a same level.

Attributes

Supertypes
trait StaticAnnotation
class Annotation
class Object
trait Matchable
class Any
class key(s: String) extends StaticAnnotation

Annotation for control over the strings used to serialize your data structure. Can be applied in three ways:

Annotation for control over the strings used to serialize your data structure. Can be applied in three ways:

  1. To individual fields, in which case it overrides the JSON object fieldname

  2. To case classes which are part of sealed traits, where it overrides the value of the "$type": "foo" discriminator field

  3. To sealed traits themselves, where it overrides the key of the "$type": "foo" discriminator field

Attributes

Supertypes
trait StaticAnnotation
class Annotation
class Object
trait Matchable
class Any
class serializeDefaults(s: Boolean) extends StaticAnnotation

Annotation for fine-grained control of the def serializeDefaults configuration on the upickle bundle; can be applied to individual fields or to entire case classes, with finer-grained application taking precedence

Annotation for fine-grained control of the def serializeDefaults configuration on the upickle bundle; can be applied to individual fields or to entire case classes, with finer-grained application taking precedence

Attributes

Supertypes
trait StaticAnnotation
class Annotation
class Object
trait Matchable
class Any