rho
Encapsulation of metadata and a result generator
Encapsulation of metadata and a result generator
The type of HList required to execute the Action.
Information about the status and type the Action will produce.
Encodings that the response supports.
Function of Request and the HList to a Task[Response]
The AuthedContext provides a convenient way to define a RhoRoutes which works with http4s authentication middleware.
The AuthedContext provides a convenient way to define a RhoRoutes
which works with http4s authentication middleware.
Please note that AuthMiddleware-wrapping is mandatory, otherwise context
doesn't take effect.
case class User(name: String, id: UUID) val middleware = AuthMiddleware { req => OptionT(IO(User("Bob", UUID.randomUUID()))) } object Auth extends AuthedContext[IO, User] object BobRoutes extends RhoRoutes[IO] { GET +? param("foo", "bar") >>> Auth.auth |>> { (foo: String, user: User) => Ok(s"Bob with id ${user.id}, foo $foo") } } val service = middleware.apply(Auth.toService(BobRoutes.toRoutes()))
authInfo type for this service.
Transforms a RhoRoute into an RouteType.
Transforms a RhoRoute into an RouteType.
This can be a stateful operation, storing the action for later execution or any other type of compilation phase.
Type that can accept a decoder.
Type that can accept a decoder.
A subtype of Decodable can accept an EntityDecoder for extracting a message
from the Request body.
Fully functional path building
Typed builder of query rules
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.
The HList representation of the types the route expects to extract
from a Request.
Request method to match.
Path rules to execute.
Accumulated RequestRule's.
DSL construct for building query rules without a known Method
DSL construct for building query rules without a known Method
The RequestLineBuilder doesn't know about header rules or the method.
The HList representation of the values to be extracted from the Request.
A helper for capturing the result types and status codes from routes
A type to bundle everything needed to define a route
Constructor class for defining routes
Constructor class for defining routes
The RhoRoutes provides a convenient way to define routes in a style similar to scalatra etc by providing implicit conversions and an implicit CompileRoutes inside the constructor.
new RhoRoutes[IO] { POST / "foo" / pathVar[Int] +? param[String]("param") |>> { (p1: Int, param: String) => Ok("success") } }
Object which can be compiled into a complete route The RouteExecutable is a complete set of HTTP method, path, query, and headers needed for a compiler to generate a complete route description.
Object which can be compiled into a complete route The RouteExecutable is a complete set of HTTP method, path, query, and headers needed for a compiler to generate a complete route description.
The HList representation of the types the route expects to extract
from a Request.
Types that extends this trait can be prepended with noncapturing paths
Provides the operations for generating a router
Provides the operations for generating a router
cumulative type of the required method for executing the router
request methods to match
path matching stack
header validation stack
CompileRoutes which accumulates routes and can build a HttpRoutes
A typed shell which represents the requirements of the route
A typed shell which represents the requirements of the route
The HList representation of the values to be extracted from the Request.
Defines a type that is convertible into an Uri or UriTemplate
(Since version 0.19.1) Has nothing to do with HTTP
(Since version 0.19.0-M2) Use binary instead
(Since version 0.18.0-M2) Use map or flatMap directly on the request
(Since version 0.18.0-M2) Use map or flatMap directly on the response
(Since version 0.18.5) Use cats.foldable._