org.http4s.rho

RouteExecutable

trait RouteExecutable[T <: HList] extends TypedBuilder[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

Linear Supertypes
TypedBuilder[T], UriConvertible, 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
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def headers: HeaderRule

    Untyped AST representation of the Headers to operate on

    Untyped AST representation of the Headers to operate on

    Definition Classes
    TypedBuilder

  2. abstract def makeAction[F](f: F, hf: HListToFunc[T, F]): RhoAction[T, F]

    Create a RhoAction from this RouteExecutable with the provided converters

  3. abstract def method: Method

    Method of the incoming HTTP Request

  4. abstract def path: PathRule

    Untyped AST representation of the path to operate on

    Untyped AST representation of the path to operate on

    Definition Classes
    TypedBuilder

  5. abstract def query: QueryRule

    Untyped AST representation of the query to operate on

    Untyped AST representation of the query to operate on

    Definition Classes
    TypedBuilder

Concrete Value Members

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

    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Definition Classes
    AnyRef → Any

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

    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  5. def asUri: Try[Uri]

    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. def asUriTemplate: Try[UriTemplate]

    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

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

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

    Definition Classes
    AnyRef

  9. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  10. def finalize(): Unit

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

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

    Definition Classes
    AnyRef → Any

  12. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  13. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

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

    Definition Classes
    AnyRef

  15. final def notify(): Unit

    Definition Classes
    AnyRef

  16. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  17. final def runWith[F, O](f: F)(implicit hf: HListToFunc[T, F]): (Request) ⇒ Option[Task[Response]]

    Provide an action from which to generate a complete route

    Provide an action from which to generate a complete route

    F

    the type of f

    O

    the type of the result generated by f

    f

    "function" used to in compiling the route

    hf

    converter used to join the HList generated by the route to the function f

    returns

    a function Request => Option[Task[Response]] which can be used as a complete route

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

    Definition Classes
    AnyRef

  19. def toString(): String

    Definition Classes
    AnyRef → Any

  20. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  23. final def |>>[F, R](f: F)(implicit hf: HListToFunc[T, F], srvc: CompileService[F, R]): R

    Compiles a HTTP request definition into an action

Inherited from TypedBuilder[T]

Inherited from UriConvertible

Inherited from AnyRef

Inherited from Any

Ungrouped