package bits
- Alphabetic
- Public
- Protected
Type Members
- class BooleanParser[F[_]] extends StringParser[F, Boolean]
- class DateParser[F[_]] extends StringParser[F, Date]
- class DoubleParser[F[_]] extends StringParser[F, Double]
- abstract class EmptyResponseGenerator[F[_]] extends ResponseGenerator
- abstract class EntityResponseGenerator[F[_]] extends ResponseGenerator
- final case class FailureResponse[F[_]](reason: ResponseReason[F]) extends ResultResponse[F, Nothing] with Product with Serializable
Response that signifies an error
Response that signifies an error
- reason
The reason for failure which can be turned into a
F[Response[F]]
.
- trait FailureResponseOps[F[_]] extends ResponseGeneratorInstances[F]
- class FloatParser[F[_]] extends StringParser[F, Float]
- trait HListToFunc[F[_], T <: HList, -U] extends AnyRef
Converter of an value of type F to the HList of type T
Converter of an value of type F to the HList of type T
- T
HList type of the incoming values
- U
type of element onto which T will be mapped
- trait HeaderAppendable[F[_], T <: HList] extends AnyRef
Base trait which is capable of appending header rules
Base trait which is capable of appending header rules
- T
The
HList
representation of the values to be extracted from theRequest
.
- case class HeaderMetaData[T <: Extractable](key: T, isRequired: Boolean) extends Metadata with Product with Serializable
Metadata about a header rule
- class InstantParser[F[_]] extends StringParser[F, Instant]
- class IntParser[F[_]] extends StringParser[F, Int]
- abstract class LocationResponseGenerator[F[_]] extends ResponseGenerator
- class LongParser[F[_]] extends StringParser[F, Long]
- trait MatchersHListToFunc[F[_]] extends AnyRef
- trait Metadata extends AnyRef
Base type for data that can be used to decorate the rules trees
Base type for data that can be used to decorate the rules trees
Metadata is not directly useful for evaluating a request or for generating HTTP responses; it is primarily used for storing data to auto generate information about a route or service.
- trait MethodAliases extends AnyRef
- case class NoMatch[F[_]]() extends RouteResult[F, Nothing] with Product with Serializable
Failure to match a route
- case class QueryMetaData[F[_], T](name: String, description: Option[String], p: QueryParser[F, T], default: Option[T], m: scala.reflect.api.JavaUniverse.TypeTag[T]) extends Metadata with Product with Serializable
Metadata about a query rule
- trait QueryParser[F[_], A] extends AnyRef
Extract a value from the
Request
Query
Extract a value from the
Request
Query
- A
Type of value produced by the parser.
- trait QueryParsers[F[_]] extends FailureResponseOps[F]
- sealed trait ResponseGenerator extends AnyRef
Helpers to aid in the construction of a response function
Helpers to aid in the construction of a response function
These helpers provide the foundation for the response generation in the rho DSL. They require the needed codecs and generate a response with the correct meta data.
{ req => Ok("foo!") }
- trait ResponseGeneratorInstances[F[_]] extends AnyRef
- final class ResponseReason[F[_]] extends AnyRef
Concrete representation of the
FailureResponse
- sealed trait ResultInfo extends AnyRef
Information about the response type
- trait ResultMatcher[F[_], -R] extends AnyRef
- trait ResultMatcherOps extends AnyRef
- sealed trait ResultResponse[F[_], +T] extends RouteResult[F, T]
Node in the ADT that represents a result, either success or failure
- sealed trait RouteResult[F[_], +T] extends AnyRef
Types that represent the result of executing a step of the route
- trait SecurityScopesMetaData extends Metadata
Security Scope meta data
- class ShortParser[F[_]] extends StringParser[F, Short]
- case class StatusAndType(status: Status, tpe: scala.reflect.api.JavaUniverse.Type) extends ResultInfo with Product with Serializable
- case class StatusOnly(status: Status) extends ResultInfo with Product with Serializable
- trait StringParser[F[_], T] extends ResponseGeneratorInstances[F]
Parse values from a
String
Parse values from a
String
- T
The result type generated by the parser.
- final case class SuccessResponse[F[_], +T](result: T) extends ResultResponse[F, T] with Product with Serializable
Successful response
- trait TextMetaData extends Metadata
Textual meta data
- case class TypeOnly(tpe: scala.reflect.api.JavaUniverse.Type) extends ResultInfo with Product with Serializable
- final case class TypedHeader[F[_], T <: HList](rule: RequestRule[F]) extends Product with Serializable
Typed shell for the Header operations of the DSL
- final case class TypedQuery[F[_], T <: HList](rule: RequestRule[F]) extends UriConvertible[F] with Product with Serializable
Typed shell for the Query operations of the DSL
- class UUIDParser[F[_]] extends StringParser[F, UUID]
Value Members
- object FailureResponse extends Serializable
- object FailureResponseOps
- object MethodAliases extends MethodAliases
- object PathAST
Actual elements which build up the AST
- object PathTree
- object QueryParser
- object RequestAST
Rules for extracting non-path related data from the
Request
Rules for extracting non-path related data from the
Request
This AST is subject to change.
- object ResultMatcher extends ResultMatcherOps
- object StringParser
- object TypedQuery extends Serializable
- object UriConverter
Helps to convert different parts of a route into an
UriTemplate