org.http4s.rho

PathBuilder

final class PathBuilder[T <: HList] extends HeaderAppendable[T] with RouteExecutable[T] with UriConvertible

Fully functional path building

Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. PathBuilder
  2. RouteExecutable
  3. TypedBuilder
  4. UriConvertible
  5. HeaderAppendable
  6. AnyRef
  7. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new PathBuilder(method: Method, path: PathRule)

Type Members

  1. type Self = PathBuilder[T]

    Definition Classes
    PathBuilderHeaderAppendable

Value Members

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

    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Definition Classes
    AnyRef → Any
  3. def +?[T1 <: HList](q: TypedQuery[T1])(implicit prep: Prepend[T1, T]): QueryBuilder[Out]

  4. def /[T2 <: HList](t: RequestLineBuilder[T2])(implicit prep: Prepend[T2, T]): QueryBuilder[Out]

  5. def /[T2 <: HList](t: PathBuilder[T2])(implicit prep: Prepend[T2, T]): PathBuilder[Out]

  6. def /[T2 <: HList](t: TypedPath[T2])(implicit prep: Prepend[T2, T]): PathBuilder[Out]

  7. def /(s: Symbol): PathBuilder[::[String, T]]

  8. def /(s: String): PathBuilder[T]

  9. def /(t: CaptureTail.type): Router[::[List[String], T]]

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

    Definition Classes
    AnyRef → Any
  11. def >>>[T1 <: HList](h2: TypedHeader[T1])(implicit prep: Prepend[T1, T]): Router[Out]

    Append the header to the builder, generating a new typed representation of the route

    Append the header to the builder, generating a new typed representation of the route

    Definition Classes
    PathBuilderHeaderAppendable
  12. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  13. def asUri(request: Request): 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
  14. def asUriTemplate(request: Request): 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
    PathBuilderTypedBuilderUriConvertible
  15. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  16. def decoding[R](dec: EntityDecoder[R]): CodecRouter[T, R]

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

    Definition Classes
    AnyRef
  18. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  19. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  20. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  21. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  22. def headers: HeaderRule

    Untyped AST representation of the Headers to operate on

    Untyped AST representation of the Headers to operate on

    Definition Classes
    PathBuilderTypedBuilder
  23. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  24. def makeAction[F](f: F, hf: HListToFunc[T, F]): RhoAction[T, F]

    Create a RhoAction from this RouteExecutable with the provided converters

    Create a RhoAction from this RouteExecutable with the provided converters

    Definition Classes
    PathBuilderRouteExecutable
  25. val method: Method

    Method of the incoming HTTP Request

    Method of the incoming HTTP Request

    Definition Classes
    PathBuilderRouteExecutable
  26. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  27. final def notify(): Unit

    Definition Classes
    AnyRef
  28. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  29. val path: PathRule

    Untyped AST representation of the path to operate on

    Untyped AST representation of the path to operate on

    Definition Classes
    PathBuilderTypedBuilder
  30. def query: QueryRule

    Untyped AST representation of the query to operate on

    Untyped AST representation of the query to operate on

    Definition Classes
    PathBuilderTypedBuilder
  31. 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

    Definition Classes
    RouteExecutable
  32. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  33. def toAction: Router[T]

  34. def toString(): String

    Definition Classes
    AnyRef → Any
  35. def validate[T1 <: HList](h2: TypedHeader[T1])(implicit prep: Prepend[T1, T]): Router[Out]

  36. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  38. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  39. final def |>>[F, R](f: F)(implicit hf: HListToFunc[T, F], srvc: CompileService[F, R]): R

    Compiles a HTTP request definition into an action

    Compiles a HTTP request definition into an action

    Definition Classes
    RouteExecutable

Inherited from RouteExecutable[T]

Inherited from TypedBuilder[T]

Inherited from UriConvertible

Inherited from HeaderAppendable[T]

Inherited from AnyRef

Inherited from Any

Ungrouped