Type Members

1.  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 Codec.deriveEnum.
   - Annotate a type for fixed documentation when using Codec.deriveFixed.
   - Annotate a case class for record documentation when using Codec.derive from the generic module.
   - Annotate a case class parameter for record field documentation when using Codec.derive from the generic module.

2.  sealed abstract class AvroError extends AnyRef

   Error which occurred while generating a schema, or while encoding or decoding.

   Error which occurred while generating a schema, or while encoding or decoding.

   Use AvroError.apply to create an instance, and AvroError#message to retrieve the message.

3.  sealed abstract class AvroException extends RuntimeException

   Throwable representation of an AvroError, created with AvroError#throwable.

4.  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 Codec.deriveEnum.
   - Annotate a type for fixed namespace when using Codec.deriveFixed.
   - Annotate a case class for record namespace when using Codec.derive from the generic module.

5.  sealed abstract class Codec[A] extends AnyRef

   Provides a schema, along with encoding and decoding functions for a given type.

   Provides a schema, along with encoding and decoding functions for a given type.

   Annotations

   @implicitNotFound("could not find implicit Codec[${A}]; ensure no imports are missing or manually define an instance")

6.  sealed abstract class Prism[S, A] extends AnyRef

   Optic used for selecting a part of a coproduct type.

   Optic used for selecting a part of a coproduct type.

   Annotations

   @implicitNotFound("could not find implicit Prism[${S}, ${A}]; ensure ${A} is a subtype of ${S} or manually define an instance")

7.  sealed abstract class Props extends AnyRef

   Custom properties which can be included in a schema.

   Custom properties which can be included in a schema.

   Use Props.one to create an instance, and Props#add to add more properties.