c

org.http4s.rho

RequestLineBuilder

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 the Request.

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

Instance Constructors

  1. new RequestLineBuilder(path: PathRule, rules: RequestRule[F])

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. 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.

  4. 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
    RequestLineBuilderRoutePrependable
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. 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 of Uri. If the route is a URI Template but not an URI None will be returned.

    Definition Classes
    UriConvertible
  8. 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 of UriTemplate.

    Definition Classes
    TypedBuilderUriConvertible
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. val path: PathRule

    Untyped AST representation of the path to operate on

    Untyped AST representation of the path to operate on

    Definition Classes
    RequestLineBuilderTypedBuilder
  17. def productElementNames: Iterator[String]
    Definition Classes
    Product
  18. 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
    RequestLineBuilderTypedBuilder
  19. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  22. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. 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.

Inherited from Serializable

Inherited from Product

Inherited from Equals

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

Inherited from TypedBuilder[F, T]

Inherited from UriConvertible[F]

Inherited from AnyRef

Inherited from Any

Ungrouped