vulcan
package vulcan
- Alphabetic
- Public
- Protected
Type Members
- 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.
- sealed abstract class AvroException extends RuntimeException
Throwable
representation of an AvroError, created with AvroError#throwable. - 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()
- 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()
- sealed abstract class Props extends AnyRef
Custom properties which can be included in a schema.
Deprecated Type Members
- sealed abstract class AvroDecodingError extends AvroError
- Annotations
- @deprecated
- Deprecated
(Since version 1.5.0) Do not use - kept for binary compatibility
- 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 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.- Annotations
- @deprecated
- Deprecated
(Since version 1.3.0) Use vulcan.generic.AvroDoc from the vulcan-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 Codec.deriveEnum.
- Annotate a type for fixed namespace when using Codec.deriveFixed.
- Annotate acase class
for record namespace when usingCodec.derive
from the generic module.- Annotations
- @deprecated
- Deprecated
(Since version 1.3.0) Use vulcan.generic.AvroNamespace from the vulcan-generic module