vulcan
package vulcan
- Alphabetic
- Public
- All
Type Members
-
final
class
AvroDoc extends Annotation with StaticAnnotation
Annotation which can be used to include documentation in derived Avro
Schema
s.Annotation which can be used to include documentation in derived Avro
Schema
s. The annotation can be used in the following situations.
- Annotate a type for enum documentation when using Codec#deriveEnum.
- Annotate acase class
for record documentation when using Codec#derive.
- Annotate acase class
parameter for record field documentation when using Codec#derive. -
sealed abstract
class
AvroError extends AnyRef
Error which occurred while using Codec to generate an Avro
Schema
, or while encoding or decoding.Error which occurred while using Codec to generate an Avro
Schema
, or while encoding or decoding. A new instance can be created with AvroError#apply. We can use AvroError#message to fetch the message. -
final
class
AvroNamespace extends Annotation with StaticAnnotation
Annotation which can be used to set the namespace in derived Avro
Schema
s.Annotation which can be used to set the namespace in derived Avro
Schema
s. The annotation can be used in the following situations.
- Annotate a type for enum namespace when using Codec#deriveEnum.
- Annotate acase class
for record namespace when using Codec#derive. -
sealed abstract
class
Codec[A] extends AnyRef
Describes encoding from a type
A
to Java Avro using encode, decoding from a Java Avro type toA
using decode, and the Avro schema used in the process as schema.