Packages

p

vulcan

package vulcan

Ordering
  1. Alphabetic
Visibility
  1. Public
  2. Protected

Package Members

  1. package generic

Type Members

  1. 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.

  2. sealed abstract class AvroException extends RuntimeException

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

  3. 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()
  4. 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()
  5. 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.

Deprecated Type Members

  1. sealed abstract class AvroDecodingError extends AvroError
    Annotations
    @deprecated
    Deprecated

    (Since version 1.5.0) Do not use - kept for binary compatibility

  2. 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.

    Annotations
    @deprecated
    Deprecated

    (Since version 1.3.0) Use vulcan.generic.AvroDoc from the vulcan-generic module

  3. 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.

    Annotations
    @deprecated
    Deprecated

    (Since version 1.3.0) Use vulcan.generic.AvroNamespace from the vulcan-generic module

Value Members

  1. object Avro
  2. object AvroDecodingError
  3. object AvroError
  4. object Codec extends CodecCompanionCompat

  5. object Prism extends PrismLowPriority
  6. object Props

Ungrouped