Packages

final case class Annotated[A](codec: PathCodec[A], annotations: Chunk[MetaData[A]]) extends PathCodec[A] with Product with Serializable

Linear Supertypes
Serializable, Product, Equals, PathCodec[A], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Annotated
  2. Serializable
  3. Product
  4. Equals
  5. PathCodec
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Annotated(codec: PathCodec[A], annotations: Chunk[MetaData[A]])

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ++[B](that: PathCodec[B])(implicit combiner: Combiner[A, B]): PathCodec[Out]
    Definition Classes
    PathCodec
  4. final def /[Env](routes: Routes[Env, Response])(implicit ev: <:<[PathCodec[A], PathCodec[Unit]]): Routes[Env, Response]
    Definition Classes
    PathCodec
  5. final def /[B](that: PathCodec[B])(implicit combiner: Combiner[A, B]): PathCodec[Out]
    Definition Classes
    PathCodec
  6. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  7. def ??(doc: Doc): PathCodec[A]

    Attaches documentation to the path codec, which may be used when generating developer docs for a route.

    Attaches documentation to the path codec, which may be used when generating developer docs for a route.

    Definition Classes
    PathCodec
  8. final def annotate(metaData: MetaData[A]): PathCodec[A]
    Definition Classes
    PathCodec
  9. val annotations: Chunk[MetaData[A]]
  10. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  11. final def asType[B](implicit ev: =:=[A, B]): PathCodec[B]
    Definition Classes
    PathCodec
  12. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  13. val codec: PathCodec[A]
  14. final def decode(path: Path): Either[String, A]

    Decodes a method and path into a value of type A.

    Decodes a method and path into a value of type A.

    Definition Classes
    PathCodec
  15. def doc: Doc

    Returns the documentation for the path codec, if any.

    Returns the documentation for the path codec, if any.

    Definition Classes
    PathCodec
  16. final def encode(value: A): Either[String, Path]

    Encodes a value of type A into the method and path that this route pattern would successfully match against.

    Encodes a value of type A into the method and path that this route pattern would successfully match against.

    Definition Classes
    PathCodec
  17. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. def equals(that: Any): Boolean
    Definition Classes
    Annotated → Equals → AnyRef → Any
  19. final def example(name: String, example: A): PathCodec[A]
    Definition Classes
    PathCodec
  20. final def examples(examples: (String, A)*): PathCodec[A]
    Definition Classes
    PathCodec
  21. final def format(value: A): Either[String, Path]

    Formats a value of type A into a path.

    Formats a value of type A into a path. This is useful for embedding paths into HTML that is rendered by the server.

    Definition Classes
    PathCodec
  22. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  23. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  24. final def matches(path: Path): Boolean

    Determines if this pattern matches the specified method and path.

    Determines if this pattern matches the specified method and path. Rather than use this method, you should just try to decode it directly, for higher performance, otherwise the same information will be decoded twice.

    Definition Classes
    PathCodec
  25. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  27. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  28. def productElementNames: Iterator[String]
    Definition Classes
    Product
  29. def render: String

    Renders the path codec as a string.

    Renders the path codec as a string.

    Definition Classes
    PathCodec
  30. def segments: Chunk[SegmentCodec[_]]

    Returns the segments of the path codec.

    Returns the segments of the path codec.

    Definition Classes
    PathCodec
  31. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  32. def toString(): String
    Definition Classes
    PathCodec → AnyRef → Any
  33. final def transform[A2](f: (A) => A2)(g: (A2) => A): PathCodec[A2]
    Definition Classes
    PathCodec
  34. final def transformOrFail[A2](f: (A) => Either[String, A2])(g: (A2) => Either[String, A]): PathCodec[A2]
    Definition Classes
    PathCodec
  35. final def transformOrFailLeft[A2](f: (A) => Either[String, A2])(g: (A2) => A): PathCodec[A2]
    Definition Classes
    PathCodec
  36. final def transformOrFailRight[A2](f: (A) => A2)(g: (A2) => Either[String, A]): PathCodec[A2]
    Definition Classes
    PathCodec
  37. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  38. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  39. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from PathCodec[A]

Inherited from AnyRef

Inherited from Any

Ungrouped