• Home
• org.virtuslab.ash
• annotation_2.13
• 0.8.0
• source code
• Serializer.scala

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

org.virtuslab.ash.annotation.Serializer.scala Maven / Gradle / Ivy

package org.virtuslab.ash.annotation

import scala.annotation.nowarn

/**
 * This annotation is used by Codec Registration Checker for marking serializers.
 *
 * Compiler plugin takes the body of a marked class, collects all types that are present, filters them with provided regex and
 * extracts type parameters. Then filtered types and extracted type parameters are checked against all direct subtypes of
 * `clazz`.
 *
 * Sometimes types appear unexpectedly during type class derivation leading to false negatives, i.e. a codec reported as
 * registered even though it's NOT registered. The role of `typeRegexPattern` is to filter detected types, ensuring they are
 * used in the right context.
 *
 * For example, if we want to serialize `trait Command`, then type `Registration[Command]` is relevant, while `Option[Command]`
 * is not.
 *
 * If you are using `circe-akka-serializer`, set `typeRegexPattern` to `Register.REGISTRATION_REGEX`
 *
 * @param clazz
 *   class literal of serializability marker trait, for example `classOf[MySerializable]`
 * @param typeRegexPattern
 *   regular expression that is used for filtering detected types, before type argument extraction
 */
@nowarn("cat=unused")
class Serializer(clazz: Class[_], typeRegexPattern: String = ".*") extends scala.annotation.StaticAnnotation