upickle
Members list
Type members
Classlikes
An instance of the upickle API. There's a default instance at upickle.default, but you can also implement it yourself to customize its behavior. Override the annotate methods to control how a sealed trait instance is tagged during reading and writing.
An instance of the upickle API. There's a default instance at upickle.default, but you can also implement it yourself to customize its behavior. Override the annotate methods to control how a sealed trait instance is tagged during reading and writing.
Attributes
- Supertypes
-
trait MsgReadWriterstrait JsReadWriterstrait LowPriReadWriterstrait MacroImplicitstrait WebJsontrait Writerstrait LowPriWriterstrait WritersVersionSpecifictrait Readerstrait ReadersVersionSpecifictrait CaseClassReadWriterstrait Annotatortrait MacrosCommontrait Configtrait Generatedtrait TupleReadWriterstrait Typesclass Objecttrait Matchableclass AnyShow all
- Known subtypes
A upickle.Api that follows the default sealed-trait-instance-tagging behavior of using an attribute, but allow you to control what the name of the attribute is.
A upickle.Api that follows the default sealed-trait-instance-tagging behavior of using an attribute, but allow you to control what the name of the attribute is.
Attributes
- Supertypes
-
trait Apitrait MsgReadWriterstrait JsReadWriterstrait LowPriReadWriterstrait MacroImplicitstrait WebJsontrait Writerstrait LowPriWriterstrait WritersVersionSpecifictrait Readerstrait ReadersVersionSpecifictrait CaseClassReadWriterstrait Annotatortrait MacrosCommontrait Configtrait Generatedtrait TupleReadWriterstrait Typesclass Objecttrait Matchableclass AnyShow all
- Known subtypes
-
object default
Attributes
- Supertypes
-
trait LowPriReadWriterstrait MacroImplicitstrait Writerstrait LowPriWriterstrait WritersVersionSpecifictrait Readerstrait ReadersVersionSpecifictrait CaseClassReadWriterstrait Annotatortrait MacrosCommontrait Configtrait Generatedtrait TupleReadWriterstrait Typesclass Objecttrait Matchableclass AnyShow all
- Known subtypes
Attributes
- Supertypes
-
trait Apitrait MsgReadWriterstrait JsReadWriterstrait LowPriReadWriterstrait MacroImplicitstrait WebJsontrait Writerstrait LowPriWriterstrait WritersVersionSpecifictrait Readerstrait ReadersVersionSpecifictrait CaseClassReadWriterstrait Annotatortrait MacrosCommontrait Configtrait Generatedtrait TupleReadWriterstrait Typesclass Objecttrait Matchableclass AnyShow all
- Known subtypes
-
object legacy
Attributes
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
-
trait JsReadWriterstrait Apitrait AttributeTaggedobject defaulttrait LegacyApiobject legacyShow all
- Self type
Attributes
- Supertypes
-
trait MacroImplicitstrait Writerstrait LowPriWriterstrait WritersVersionSpecifictrait Readerstrait ReadersVersionSpecifictrait CaseClassReadWriterstrait Annotatortrait MacrosCommontrait Configtrait Generatedtrait TupleReadWriterstrait Typesclass Objecttrait Matchableclass AnyShow all
- Known subtypes
Attributes
- Supertypes
-
trait Typesclass Objecttrait Matchableclass Any
- Known subtypes
- Self type
-
Config
The default way of accessing upickle
The default way of accessing upickle
Attributes
- Supertypes
-
trait AttributeTaggedtrait Apitrait MsgReadWriterstrait JsReadWriterstrait LowPriReadWriterstrait MacroImplicitstrait WebJsontrait Writerstrait LowPriWriterstrait WritersVersionSpecifictrait Readerstrait ReadersVersionSpecifictrait CaseClassReadWriterstrait Annotatortrait MacrosCommontrait Configtrait Generatedtrait TupleReadWriterstrait Typesclass Objecttrait Matchableclass AnyShow all
- Self type
-
default.type
An instance of the upickle API that follows the old serialization for tagged instances of sealed traits: as a list with two items, the first being the type-tag and the second being the serialized object
An instance of the upickle API that follows the old serialization for tagged instances of sealed traits: as a list with two items, the first being the type-tag and the second being the serialized object
Attributes
- Supertypes
-
trait LegacyApitrait Apitrait MsgReadWriterstrait JsReadWriterstrait LowPriReadWriterstrait MacroImplicitstrait WebJsontrait Writerstrait LowPriWriterstrait WritersVersionSpecifictrait Readerstrait ReadersVersionSpecifictrait CaseClassReadWriterstrait Annotatortrait MacrosCommontrait Configtrait Generatedtrait TupleReadWriterstrait Typesclass Objecttrait Matchableclass AnyShow all
- Self type
-
legacy.type
Exports
Defined exports
Configure whether you want upickle to skip unknown keys during de-serialization of case classes. Can be overriden for the entire serializer via override def, and further overriden for individual case classes via the annotation @upickle.implicits.allowUnknownKeys(b: Boolean)
Configure whether you want upickle to skip unknown keys during de-serialization of case classes. Can be overriden for the entire serializer via override def, and further overriden for individual case classes via the annotation @upickle.implicits.allowUnknownKeys(b: Boolean)
Attributes
Whether to use the fully-qualified name of case classes and case objects which are part of sealed trait hierarchies when serializing them and writing their $type key. Defaults to false, so $type key uses the shortest partially-qualified name. Can be set to true to use their fully-qualified name.
Whether to use the fully-qualified name of case classes and case objects which are part of sealed trait hierarchies when serializing them and writing their $type key. Defaults to false, so $type key uses the shortest partially-qualified name. Can be set to true to use their fully-qualified name.
Attributes
Whether top-level Some(t)s and Nones are serialized unboxed as t or null, rather than [t] or []. This is generally what people expect, although it does cause issues where Some(null) when serialized and de-serialized can become None. Can be disabled to use the boxed serialization format as 0-or-1-element-arrays, presering round trip-ability at the expense of un-intuitiveness and verbosity
Whether top-level Some(t)s and Nones are serialized unboxed as t or null, rather than [t] or []. This is generally what people expect, although it does cause issues where Some(null) when serialized and de-serialized can become None. Can be disabled to use the boxed serialization format as 0-or-1-element-arrays, presering round trip-ability at the expense of un-intuitiveness and verbosity
Attributes
Whether or not to write case class keys which match their default values. Defaults to false, allowing those keys to be omitted. Can be set to true to always write field values even if they are equal to the default
Whether or not to write case class keys which match their default values. Defaults to false, allowing those keys to be omitted. Can be set to true to always write field values even if they are equal to the default
Attributes
Mark a ReadWriter[T] as something that can be used as a key in a JSON dictionary, such that Map[T, V] serializes to {"a": "b", "c": "d"} rather than [["a", "b"], ["c", "d"]]
Mark a ReadWriter[T] as something that can be used as a key in a JSON dictionary, such that Map[T, V] serializes to {"a": "b", "c": "d"} rather than [["a", "b"], ["c", "d"]]
Attributes
Mark a Writer[T] as something that can be used as a key in a JSON dictionary, such that Map[T, V] serializes to {"a": "b", "c": "d"} rather than [["a", "b"], ["c", "d"]]
Mark a Writer[T] as something that can be used as a key in a JSON dictionary, such that Map[T, V] serializes to {"a": "b", "c": "d"} rather than [["a", "b"], ["c", "d"]]
Attributes
Specifies the name of the field used to distinguish different case classes under a sealed trait. Defaults to $type, but can be configured globally by overriding tagName, or on a per-sealed trait basis via the @key annotation
Specifies the name of the field used to distinguish different case classes under a sealed trait. Defaults to $type, but can be configured globally by overriding tagName, or on a per-sealed trait basis via the @key annotation
Attributes
Deprecated defined exports
Attributes
- Deprecated
- true