Trait

org.http4s.rho

RouteExecutable

Related Doc: package rho

Permalink

trait RouteExecutable[F[_], T <: HList] extends TypedBuilder[F, T]

Object which can be compiled into a complete route The RouteExecutable is a complete set of HTTP method, path, query, and headers needed for a compiler to generate a complete route description.

T

The HList representation of the types the route expects to extract from a Request.

Self Type
RouteExecutable[F, T]
Linear Supertypes
TypedBuilder[F, T], UriConvertible[F], AnyRef, Any
Known Subclasses
CodecRouter, PathBuilder, QueryBuilder, Router
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RouteExecutable
  2. TypedBuilder
  3. UriConvertible
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def makeRoute(action: Action[F, T]): RhoRoute[F, T]

    Permalink

    Create a RhoRoute from a given Action

  2. abstract def method: Method

    Permalink

    Method of the incoming HTTP Request

  3. abstract val path: PathRule

    Permalink

    Untyped AST representation of the path to operate on

    Untyped AST representation of the path to operate on

    Definition Classes
    TypedBuilder

  4. abstract val rules: RequestRule[F]

    Permalink

    Untyped AST describing the extraction of headers and the query from the Request

    Untyped AST describing the extraction of headers and the query from the Request

    Definition Classes
    TypedBuilder

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. def asUri(request: Request[F]): Try[Uri]

    Permalink

    Converts a route into an Uri.

    Converts a route into an Uri.

    If the conversion fails None is returned. In case your route has multiple paths only one way will be resolved as instance of Uri. If the route is a URI Template but not an URI None will be returned.

    Definition Classes
    UriConvertible

  6. final def asUriTemplate(request: Request[F]): Try[UriTemplate]

    Permalink

    Converts a route into an UriTemplate.

    Converts a route into an UriTemplate.

    If the conversion fails None is returned. In case your route has multiple paths only one way will be resolved as instance of UriTemplate.

    Definition Classes
    TypedBuilder → UriConvertible

  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  9. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  10. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  11. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  12. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  13. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  14. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  15. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  16. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  17. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  18. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  19. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  20. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  21. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  22. final def |>>[U, R](f: U)(implicit hltf: HListToFunc[F, T, U], srvc: CompileRoutes[F, R]): R

    Permalink

    Compiles a HTTP request definition into an action

Inherited from TypedBuilder[F, T]

Inherited from UriConvertible[F]

Inherited from AnyRef

Inherited from Any

Ungrouped