PathBuilder

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]): 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

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

   

   Append the path and rules

   Append the path and rules

   builder

   RequestLineBuilder rules to append to the path capture rules.

   returns

   a new QueryBuilder that will execute the appended rules.

5. def /[T2 <: HList](rules: TypedPath[F, T2])(implicit prep: Prepend[T2, T]): PathBuilder[F, Out]

   

   Append the path rules to the PathBuilder

   Append the path rules to the PathBuilder

   rules

   TypedPath rules to append to the path capture rules.

   returns

   a new PathBuilder that will execute the appended rules.

6. def /(symbol: Symbol): PathBuilder[F, ::[String, T]]

   

   Capture a String from the path

   Capture a String from the path

   symbol

   Symbol representing the name of the segment to capture.

   returns

   a new PathBuilder that will capture a uri segment.

7. def /(segment: String): PathBuilder[F, T]

   

   Match against a String

   Match against a String

   segment

   String to match against.

   returns

   a new PathBuilder that will match against the provided String.

8. def /(tail: CaptureTail.type): Router[F, ::[List[String], T]]

   

   Capture the remaining elements in the path

   Capture the remaining elements in the path

   returns

   a Router

9. def /:(prefix: TypedPath[F, HNil]): PathBuilder[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

   PathBuilder → RoutePrependable

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

    

    Definition Classes

    AnyRef → Any

11. def >>>[T1 <: HList](h2: TypedHeader[F, T1])(implicit prep: 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

    PathBuilder → HeaderAppendable

12. 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 EntityDecoder

    Decode the body using the EntityDecoder

    Alias for decoding

    R2

    type of the result.

    decoder

    EntityDecoder to utilize for decoding the body.

    Definition Classes

    Decodable

13. final def asInstanceOf[T0]: T0

    

    Definition Classes

    Any

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

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

    TypedBuilder → UriConvertible

16. def clone(): AnyRef

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

17. def decoding[R](decoder: EntityDecoder[F, R])(implicit F: Functor[F], t: scala.reflect.api.JavaUniverse.TypeTag[R]): CodecRouter[F, T, R]

    

    Decode the body using the EntityDecoder

    Decode the body using the EntityDecoder

    Alias for the ^ operator.

    decoder

    EntityDecoder to utilize for decoding the body.

    Definition Classes

    PathBuilder → Decodable

18. final def eq(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

19. def equals(arg0: Any): Boolean

    

    Definition Classes

    AnyRef → Any

20. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

21. final def getClass(): Class[_]

    

    Definition Classes

    AnyRef → Any

22. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

23. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

24. def makeRoute(action: Action[F, T]): RhoRoute[F, T]

    

    Create a RhoRoute from a given Action

    Create a RhoRoute from a given Action

    Definition Classes

    PathBuilder → RouteExecutable

25. val method: Method

    

    Method of the incoming HTTP Request

    Method of the incoming HTTP Request

    Definition Classes

    PathBuilder → RouteExecutable

26. final def ne(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

27. final def notify(): Unit

    

    Definition Classes

    AnyRef

28. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

29. val path: PathRule

    

    Untyped AST representation of the path to operate on

    Untyped AST representation of the path to operate on

    Definition Classes

    PathBuilder → TypedBuilder

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

    PathBuilder → TypedBuilder

31. final def synchronized[T0](arg0: ⇒ T0): T0

    

    Definition Classes

    AnyRef

32. def toString(): String

    

    Definition Classes

    AnyRef → Any

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

34. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

35. final def wait(arg0: Long, arg1: Int): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

36. final def wait(arg0: Long): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

37. final def |>>[U, R](f: U)(implicit hltf: HListToFunc[F, T, U], srvc: CompileService[F, R]): R

    

    Compiles a HTTP request definition into an action

    Compiles a HTTP request definition into an action

    Definition Classes

    RouteExecutable