case class QueryBuilder[F[_], T <: HList](method: Method, path: PathRule, rules: RequestRule[F]) extends RouteExecutable[F, T] with Decodable[F, T, Nothing] 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.
- Alphabetic
- By Inheritance
- QueryBuilder
- Serializable
- Product
- Equals
- RoutePrependable
- HeaderAppendable
- Decodable
- RouteExecutable
- TypedBuilder
- UriConvertible
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new QueryBuilder(method: Method, path: PathRule, rules: RequestRule[F])
- method
Request method to match.
- path
Path rules to execute.
- rules
Accumulated RequestRule's.
Type Members
- type HeaderAppendResult[T <: HList] = Router[F, T]
- Definition Classes
- QueryBuilder → HeaderAppendable
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##(): Int
- Definition Classes
- AnyRef → Any
- def &[T1 <: HList](query: TypedQuery[F, T1])(implicit prep: Prepend[T1, T]): QueryBuilder[F, Out]
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.
- def /:(prefix: TypedPath[F, HNil]): QueryBuilder[F, T]
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
- QueryBuilder → RoutePrependable
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def >>>[T1 <: HList](rule: TypedHeader[F, T1])(implicit prep1: Prepend[T1, T]): Router[F, 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
- QueryBuilder → HeaderAppendable
- final def ^[R2 >: Nothing](decoder: EntityDecoder[F, R2])(implicit F: Functor[F], t: scala.reflect.api.JavaUniverse.TypeTag[R2]): CodecRouter[F, T, R2]
Decode the body using the
EntityDecoderDecode the body using the
EntityDecoderAlias for decoding
- R2
type of the result.
- decoder
EntityDecoderto utilize for decoding the body.
- Definition Classes
- Decodable
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def asUri(request: Request[F]): Try[Uri]
Converts a route into an
Uri.Converts a route into an
Uri.If the conversion fails
Noneis returned. In case your route has multiple paths only one way will be resolved as instance ofUri. If the route is a URI Template but not an URINonewill be returned.- Definition Classes
- UriConvertible
- final def asUriTemplate(request: Request[F]): Try[UriTemplate]
Converts a route into an
UriTemplate.Converts a route into an
UriTemplate.If the conversion fails
Noneis returned. In case your route has multiple paths only one way will be resolved as instance ofUriTemplate.- Definition Classes
- TypedBuilder → UriConvertible
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- def decoding[R2](decoder: EntityDecoder[F, R2])(implicit F: Functor[F], t: scala.reflect.api.JavaUniverse.TypeTag[R2]): CodecRouter[F, T, R2]
Decode the body using the
EntityDecoderDecode the body using the
EntityDecoderAlias for the
^operator.- R2
type of the result.
- decoder
EntityDecoderto utilize for decoding the body.
- Definition Classes
- QueryBuilder → Decodable
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def makeRoute(action: Action[F, T]): RhoRoute[F, T]
Create a RhoRoute from a given Action
- Definition Classes
- QueryBuilder → RouteExecutable
- val method: Method
Methodof the incoming HTTPRequestMethodof the incoming HTTPRequest- Definition Classes
- QueryBuilder → RouteExecutable
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- val path: PathRule
Untyped AST representation of the path to operate on
Untyped AST representation of the path to operate on
- Definition Classes
- QueryBuilder → TypedBuilder
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val rules: RequestRule[F]
Untyped AST describing the extraction of headers and the query from the
RequestUntyped AST describing the extraction of headers and the query from the
Request- Definition Classes
- QueryBuilder → TypedBuilder
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- final def validate[T1 <: HList](header: TypedHeader[F, T1])(implicit prep: Prepend[T1, T]): HeaderAppendResult[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
- HeaderAppendable
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def |>>[U, R](f: U)(implicit hltf: HListToFunc[F, T, U], srvc: CompileRoutes[F, R]): R
Compiles a HTTP request definition into an action
Compiles a HTTP request definition into an action
- Definition Classes
- RouteExecutable
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated @deprecated
- Deprecated
(Since version ) see corresponding Javadoc for more information.