Packages

package http

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. http
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Package Members

  1. package internals

Type Members

  1. final class BodyPartial[A] extends AnyRef
  2. final class CaseInsensitive extends Ordered[CaseInsensitive] with Serializable
  3. 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.

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

  5. sealed abstract class HttpBinding extends Product with Serializable
  6. sealed trait HttpContractError extends Throwable with NoStackTrace
  7. trait HttpEndpoint[I] extends AnyRef
  8. type HttpMediaType = http.HttpMediaType.Type
  9. sealed trait HttpMethod extends Product with Serializable
  10. trait HttpStatusCode[A] extends AnyRef

    Typeclass construct allowing to retrieve the status code associated to a value.

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

  12. sealed trait MetadataError extends Throwable with HttpContractError
  13. final class MetadataPartial[A] extends AnyRef
  14. type PathParams = Map[String, String]
  15. sealed trait PathSegment extends AnyRef
  16. case class PayloadError(path: PayloadPath, expected: String, message: String) extends Throwable with HttpContractError with Product with Serializable
  17. case class UnknownErrorResponse(code: Int, headers: Map[String, String], body: String) extends Throwable with Product with Serializable

Value Members

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

  2. final def httpMatch[Alg[_[_, _, _, _, _]]](service: Service[Alg], method: HttpMethod, path: String): Option[(Service.Endpoint[_, _, _, _, _], HttpEndpoint[_], Map[String, String])]
  3. object BodyPartial
  4. object CaseInsensitive extends Serializable
  5. object CodecAPI
  6. object ErrorAltPicker
  7. object HttpBinding extends Companion[HttpBinding] with Serializable
  8. object HttpContractError extends Serializable
  9. object HttpEndpoint
  10. object HttpMediaType extends Newtype[String]
  11. object HttpMethod extends Serializable
  12. object HttpStatusCode extends Impl[HttpStatusCode]
  13. object Metadata extends Serializable
  14. object MetadataError extends Serializable
  15. object MetadataPartial
  16. object PathSegment
  17. object PayloadError extends Serializable
  18. object matchPath

Inherited from AnyRef

Inherited from Any

Ungrouped