final case class RequestLineBuilder[F[_], T <: HList](path: PathRule, rules: RequestRule[F]) extends TypedBuilder[F, T] with RoutePrependable[F, RequestLineBuilder[F, T]] with UriConvertible[F] with Product with Serializable
DSL construct for building query rules without a known Method
The RequestLineBuilder doesn't know about header rules or the method.
- T
The
HList
representation of the values to be extracted from theRequest
.
- Alphabetic
- By Inheritance
- RequestLineBuilder
- Serializable
- Product
- Equals
- RoutePrependable
- TypedBuilder
- UriConvertible
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new RequestLineBuilder(path: PathRule, rules: RequestRule[F])
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]): RequestLineBuilder[F, Out]
Capture a query rule
Capture a query rule
- T1
The 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]): RequestLineBuilder[F, T]
Prepend the prefix to the path rules
Prepend the prefix to the path rules
- prefix
The non-capturing prefix to prepend.
- returns
A RequestLineBuilder with the prefix prepended to the path rules.
- Definition Classes
- RequestLineBuilder → RoutePrependable
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- 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
None
is 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 URINone
will 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
None
is 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()
- 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
- 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
- RequestLineBuilder → TypedBuilder
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val rules: RequestRule[F]
Untyped AST describing the extraction of headers and the query from the
Request
Untyped AST describing the extraction of headers and the query from the
Request
- Definition Classes
- RequestLineBuilder → TypedBuilder
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- 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])
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.