Class

org.http4s.rho

QueryBuilder

Related Doc: package rho

Permalink

case class QueryBuilder[F[_], T <: HList](method: Method, path: PathRule, rules: RequestRule[F]) extends RouteExecutable[F, T] with HeaderAppendable[F, T] with UriConvertible[F] with RoutePrependable[F, QueryBuilder[F, T]] with Product with Serializable

Typed builder of query rules

The QueryBuilder represents a builder for routes that already have a defined method and path. It can accumulate query rules and mount decoders.

T

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

method

Request method to match.

path

Path rules to execute.

rules

Accumulated RequestRule's.

Linear Supertypes
Serializable, Serializable, Product, Equals, RoutePrependable[F, QueryBuilder[F, T]], HeaderAppendable[F, T], RouteExecutable[F, T], TypedBuilder[F, T], UriConvertible[F], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. QueryBuilder
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. RoutePrependable
  7. HeaderAppendable
  8. RouteExecutable
  9. TypedBuilder
  10. UriConvertible
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new QueryBuilder(method: Method, path: PathRule, rules: RequestRule[F])

    Permalink

    method

    Request method to match.

    path

    Path rules to execute.

    rules

    Accumulated RequestRule's.

Type Members

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

    Permalink
    Definition Classes
    QueryBuilderHeaderAppendable

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](query: TypedQuery[F, T1])(implicit prep: Prepend[T1, T]): QueryBuilder[F, Out]

    Permalink

    Capture a query rule

    Capture a query rule

    T1

    types of elements captured by query.

    query

    Query capture rule.

    returns

    a QueryBuilder with which to continue building the route.

  4. def /:(prefix: TypedPath[F, HNil]): QueryBuilder[F, T]

    Permalink

    Prepend the prefix to the path rules

    Prepend the prefix to the path rules

    prefix

    non-capturing prefix to prepend

    returns

    builder with the prefix prepended to the path rules

    Definition Classes
    QueryBuilderRoutePrependable
  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  6. def >>>[T1 <: HList](rule: TypedHeader[F, T1])(implicit prep1: Prepend[T1, T]): Router[F, 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
    QueryBuilderHeaderAppendable
  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  8. 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
  9. 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
    TypedBuilderUriConvertible
  10. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  12. def finalize(): Unit

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

    Permalink
    Definition Classes
    AnyRef → Any
  14. final def isInstanceOf[T0]: Boolean

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

    Permalink

    Create a RhoRoute from a given Action

    Create a RhoRoute from a given Action

    Definition Classes
    QueryBuilderRouteExecutable
  16. val method: Method

    Permalink

    Request method to match.

    Request method to match.

    Definition Classes
    QueryBuilderRouteExecutable
  17. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  20. val path: PathRule

    Permalink

    Path rules to execute.

    Path rules to execute.

    Definition Classes
    QueryBuilderTypedBuilder
  21. val rules: RequestRule[F]

    Permalink

    Accumulated RequestRule's.

    Accumulated RequestRule's.

    Definition Classes
    QueryBuilderTypedBuilder
  22. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  23. final def validate[T1 <: HList](header: TypedHeader[F, T1])(implicit prep: Prepend[T1, T]): HeaderAppendResult[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
    HeaderAppendable
  24. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. 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

    Compiles a HTTP request definition into an action

    Definition Classes
    RouteExecutable

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from RoutePrependable[F, QueryBuilder[F, T]]

Inherited from HeaderAppendable[F, T]

Inherited from RouteExecutable[F, T]

Inherited from TypedBuilder[F, T]

Inherited from UriConvertible[F]

Inherited from AnyRef

Inherited from Any

Ungrouped