final class paramTag[BaseTag <: RpcTag] extends Annotation with RawSymAnnotation

Parameter tagging lets you have more explicit control over which raw parameters can match which real parameters. This way you can have some of the parameters annotated in order to treat them differently, e.g. they may be verbatim, encoded in a different way or collected to a different raw container (e.g. Map[String,Raw] vs List[Raw] - see multi for more details).

Example:

sealed trait RestParam extends RpcTag
class Body extends RestParam
class Url extends RestParam
class Path extends RestParam

@paramTag[RestParam](new Body)
trait RestRawRpc {
  def get(
    @methodName name: String,
    @multi @verbatim @tagged[Path] pathParams: List[String],
    @multi @verbatim @tagged[Url] urlParams: Map[String,String],
    @multi @tagged[Body] bodyParams: Map[String,Json]
  ): Future[Json]
}

NOTE: The example above assumes there is a Json type defined with appropriate encodings - see encoded for more details on parameter and method result encoding.

The example above configures parameter tag type for the entire trait, but you can also do it for each raw method, e.g.

trait RestRawRpc {
  @paramTag[RestParam](new Body)
  def get(...)
}
BaseTag

base type for tags that can be used on real RPC parameters

Linear Supertypes
RawSymAnnotation, StaticAnnotation, Annotation, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. paramTag
  2. RawSymAnnotation
  3. StaticAnnotation
  4. Annotation
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new paramTag(defaultTag: BaseTag = null)

    defaultTag

    default tag value assumed for untagged real parameters

Value Members

  1. val defaultTag: BaseTag