Class

org.http4s.rho

PathBuilder

Related Doc: package rho

Permalink

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

Fully functional path building

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

Instance Constructors

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

    Permalink

Type Members

  1. type HeaderAppendResult[T <: HList] = Router[T]

    Permalink
    Definition Classes
    PathBuilderHeaderAppendable

Value Members

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

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

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

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

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

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

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

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

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

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

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

    Permalink

    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 ^[R2 >: Nothing](decoder: EntityDecoder[R2])(implicit t: scala.reflect.api.JavaUniverse.TypeTag[R2]): CodecRouter[T, R2]

    Permalink

    Alias for decoding

    Alias for decoding

    Definition Classes
    Decodable
  13. final def asInstanceOf[T0]: T0

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  17. def decoding[R](decoder: EntityDecoder[R])(implicit t: scala.reflect.api.JavaUniverse.TypeTag[R]): CodecRouter[T, R]

    Permalink

    Decode the body using the EntityDecoder

    Decode the body using the EntityDecoder

    Definition Classes
    PathBuilderDecodable
  18. final def eq(arg0: AnyRef): Boolean

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

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  23. def headers: HeaderRule

    Permalink

    Untyped AST representation of the Headers to operate on

    Untyped AST representation of the Headers to operate on

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

    Permalink
    Definition Classes
    Any
  25. def makeRoute(action: Action[T]): RhoRoute[T]

    Permalink
    Definition Classes
    PathBuilderRouteExecutable
  26. val method: Method

    Permalink

    Method of the incoming HTTP Request

    Method of the incoming HTTP Request

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

    Permalink
    Definition Classes
    AnyRef
  28. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  29. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  30. val path: PathRule

    Permalink

    Untyped AST representation of the path to operate on

    Untyped AST representation of the path to operate on

    Definition Classes
    PathBuilderTypedBuilder
  31. def query: QueryRule

    Permalink

    Untyped AST representation of the query to operate on

    Untyped AST representation of the query to operate on

    Definition Classes
    PathBuilderTypedBuilder
  32. final def runWith[F](f: F)(implicit hltf: HListToFunc[T, F]): (Request) ⇒ Task[Response]

    Permalink

    Provide an action from which to generate a complete route

    Provide an action from which to generate a complete route

    returns

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

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

    Permalink
    Definition Classes
    AnyRef
  34. def toAction: Router[T]

    Permalink
  35. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  36. final def validate[T2 <: HList](header: TypedHeader[T2])(implicit prep: Prepend[T2, T]): HeaderAppendResult[Out]

    Permalink
    Definition Classes
    HeaderAppendable
  37. final def wait(): Unit

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

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

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

    Permalink

    Compiles a HTTP request definition into an action

    Compiles a HTTP request definition into an action

    Definition Classes
    RouteExecutable

Inherited from HeaderAppendable[T]

Inherited from Decodable[T, Nothing]

Inherited from RouteExecutable[T]

Inherited from TypedBuilder[T]

Inherited from UriConvertible

Inherited from AnyRef

Inherited from Any

Ungrouped