package generic
- Alphabetic
- By Inheritance
- generic
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
-
final
class
AvroDoc extends Annotation with StaticAnnotation
Annotation which can be used to include documentation in derived schemas.
Annotation which can be used to include documentation in derived schemas.
The annotation can be used in the following situations.
- Annotate a type for enum documentation when using deriveEnum.
- Annotate a type for fixed documentation when using deriveFixed.
- Annotate acase class
for record documentation when usingCodec.derive
from the generic module.
- Annotate acase class
parameter for record field documentation when usingCodec.derive
from the generic module. -
final
class
AvroName extends Annotation with StaticAnnotation
Annotation which can be used to alter the record name in derived schemas.
Annotation which can be used to alter the record name in derived schemas.
The annotation can be used in the following situations.
- Annotate a type for enum name when using deriveEnum.
- Annotate a type for fixed name when using deriveFixed.
- Annotate acase class
for record name when usingCodec.derive
from the generic module.
- Annotate acase class
parameter for record field name when usingCodec.derive
from the generic module. -
final
class
AvroNamespace extends Annotation with StaticAnnotation
Annotation which can be used to set the namespace in derived schemas.
Annotation which can be used to set the namespace in derived schemas.
The annotation can be used in the following situations.
- Annotate a type for enum namespace when using deriveEnum.
- Annotate a type for fixed namespace when using deriveFixed.
- Annotate acase class
for record namespace when usingCodec.derive
from the generic module. -
final
class
AvroNullDefault extends Annotation with StaticAnnotation
Annotation which can be used to enable/disable explicit default null values for nullable fields in derived schemas.
Annotation which can be used to enable/disable explicit default null values for nullable fields in derived schemas.
The annotation can be used in the following situations.
- Annotate acase class
to enable/disable explicit default null values in the schema for all nullable fields when usingCodec.derive
from the generic module.
- Annotate acase class
parameter to enable/disable explicit default null value in the schema for this specific nullable field when usingCodec.derive
from the generic module.Parameter
annotation takes precedence overcase class
one when both are used. - implicit final class MagnoliaCodec extends AnyVal
Value Members
- implicit final val cnilCodec: Aux[Nothing, CNil]
- implicit final def coproductCodec[H, T <: Coproduct](implicit headCodec: Codec[H], tailCodec: Lazy[Codec[T]]): Codec[:+:[H, T]]
- implicit final def coproductPrism[C <: Coproduct, A](implicit inject: Inject[C, A], selector: Selector[C, A]): Prism[C, A]
-
final
def
deriveEnum[A](symbols: Seq[String], encode: (A) ⇒ String, decode: (String) ⇒ Either[AvroError, A])(implicit tag: scala.reflect.api.JavaUniverse.WeakTypeTag[A]): Aux[EnumSymbol, A]
Returns an enum
Codec
for typeA
, deriving details like the name, namespace, and AvroDoc documentation from the typeA
using type tags. -
final
def
deriveFixed[A](size: Int, encode: (A) ⇒ Array[Byte], decode: (Array[Byte]) ⇒ Either[AvroError, A])(implicit tag: scala.reflect.api.JavaUniverse.WeakTypeTag[A]): Aux[Fixed, A]
Returns a fixed
Codec
for typeA
, deriving details like the name, namespace, and AvroDoc documentation from the typeA
using type tags. - object AvroNullDefault