package http
- Alphabetic
- By Inheritance
- http
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- final class BodyPartial[A] extends AnyRef
- final class CaseInsensitive extends Ordered[CaseInsensitive] with Serializable
- trait CodecAPI extends AnyRef
An abstraction exposing serialisation functions to decode from bytes / encode to bytes, based on a path-dependant Codec types.
An abstraction exposing serialisation functions to decode from bytes / encode to bytes, based on a path-dependant Codec types.
Only used in unary request/response patterns.
- final class ErrorAltPicker[E] extends AnyRef
Utility class to help find the best alternative out of a error union type.
Utility class to help find the best alternative out of a error union type. This is useful when deserializing on the client side of a request/ response round trip.
- sealed abstract class HttpBinding extends Product with Serializable
- sealed trait HttpContractError extends Throwable with NoStackTrace
- trait HttpEndpoint[I] extends AnyRef
- type HttpMediaType = http.HttpMediaType.Type
- sealed trait HttpMethod extends Product with Serializable
- trait HttpStatusCode[A] extends AnyRef
Typeclass construct allowing to retrieve the status code associated to a value.
- case class Metadata(path: Map[String, String] = Map.empty, query: Map[String, Seq[String]] = Map.empty, headers: Map[CaseInsensitive, Seq[String]] = Map.empty, statusCode: Option[Int] = None) extends Product with Serializable
Datatype containing metadata associated to a http message.
Datatype containing metadata associated to a http message.
The metadata is what is found in the http headers, and can be derived from the http path, the query parameters, or the headers.
Associated to it are a pair of Encoder/Decoder typeclasses, that can be derived from a schema.
- path
the path parameters of the http message
- query
the query parameters of the http message
- headers
the header parameters of the http message
- sealed trait MetadataError extends Throwable with HttpContractError
- final class MetadataPartial[A] extends AnyRef
- type PathParams = Map[String, String]
- sealed trait PathSegment extends AnyRef
- case class PayloadError(path: PayloadPath, expected: String, message: String) extends Throwable with HttpContractError with Product with Serializable
- case class UnknownErrorResponse(code: Int, headers: Map[String, String], body: String) extends Throwable with Product with Serializable
Value Members
- final def httpMatch[Alg[_[_, _, _, _, _]]](service: Service[Alg], method: HttpMethod, pathSegments: Vector[String]): Option[(Service.Endpoint[_, _, _, _, _], HttpEndpoint[_], Map[String, String])]
Returns the first http endpoint that matches both a method and path, as well as the map of extracted segment values.
- final def httpMatch[Alg[_[_, _, _, _, _]]](service: Service[Alg], method: HttpMethod, path: String): Option[(Service.Endpoint[_, _, _, _, _], HttpEndpoint[_], Map[String, String])]
- object BodyPartial
- object CaseInsensitive extends Serializable
- object CodecAPI
- object ErrorAltPicker
- object HttpBinding extends Companion[HttpBinding] with Serializable
- object HttpContractError extends Serializable
- object HttpEndpoint
- object HttpMediaType extends Newtype[String]
- object HttpMethod extends Serializable
- object HttpStatusCode extends Impl[HttpStatusCode]
- object Metadata extends Serializable
- object MetadataError extends Serializable
- object MetadataPartial
- object PathSegment
- object PayloadError extends Serializable
- object matchPath