core
API
Generated with
© 2002-2021 · LAMP/EPFL
© 2002-2021 · LAMP/EPFL
core/smithy4s.http

smithy4s.http

package smithy4s.http

Members list

Concise view

Type members

Classlikes

final class BodyPartial[A]

Attributes

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any
object BodyPartial

Attributes

Companion:
class
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
final class CaseInsensitive extends Ordered[CaseInsensitive] with Serializable

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Comparable[CaseInsensitive]
class Object
trait Matchable
class Any
object CaseInsensitive

Attributes

Companion:
class
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
trait CodecAPI

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.

Attributes

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object CodecAPI

Attributes

Companion:
trait
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
final class ErrorAltPicker[E](alts: Vector[Alt[Schema, E, _]])

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.

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.

Attributes

alts

alternatives of the error union to choose from

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any
object ErrorAltPicker

Attributes

Companion:
class
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
sealed abstract class HttpBinding(val tpe: Type) extends Product with Serializable

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Known subtypes
object QueryParamsBinding.type
object StatusCodeBinding.type
object HttpBinding extends Companion[HttpBinding]

Attributes

Companion:
class
Graph
Supertypes
trait Sum
trait Mirror
trait HasId
class Object
trait Matchable
class Any
Self type
sealed trait HttpContractError extends Throwable with NoStackTrace

Attributes

Companion:
object
Graph
Supertypes
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Known subtypes
class NotFound
class WrongType
object HttpContractError

Attributes

Companion:
trait
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
trait HttpEndpoint[I]

Attributes

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any
object HttpEndpoint

Attributes

Companion:
trait
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
object HttpMediaType extends Newtype[String]

Attributes

Graph
Supertypes
trait HasId
class Object
trait Matchable
class Any
Self type
sealed trait HttpMethod

Attributes

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object DELETE.type
object GET.type
object PATCH.type
object POST.type
object PUT.type
object HttpMethod

Attributes

Companion:
trait
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
trait HttpStatusCode[A]

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

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

Attributes

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any
object HttpStatusCode

Attributes

Companion:
trait
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
case class Metadata(path: Map[String, String], query: Map[String, Seq[String]], headers: Map[CaseInsensitive, Seq[String]], statusCode: Option[Int])

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.

Attributes

headers

the header parameters of the http message

path

the path parameters of the http message

query

the query parameters of the http message

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Self type
object Metadata

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed trait MetadataError extends HttpContractError

Attributes

Companion:
object
Graph
Supertypes
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Known subtypes
class NotFound
class WrongType
object MetadataError

Attributes

Companion:
trait
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
final class MetadataPartial[A]

Attributes

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any
object MetadataPartial

Attributes

Companion:
class
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
sealed trait PathSegment

Attributes

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object PathSegment

Attributes

Companion:
trait
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
case class PayloadError(path: PayloadPath, expected: String, message: String) extends HttpContractError

Attributes

Companion:
object
Graph
Supertypes
trait Product
trait Equals
class Throwable
trait Serializable
class Object
trait Matchable
class Any
object PayloadError

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class UnknownErrorResponse(code: Int, headers: Map[String, String], body: String) extends Throwable

Attributes

Graph
Supertypes
trait Product
trait Equals
class Throwable
trait Serializable
class Object
trait Matchable
class Any
object matchPath

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Types

Value members

Concrete methods

final def httpMatch[Alg[_[_, _, _, _, _]], Op[_, _, _, _, _]](serviceProvider: Provider[Alg, Op], method: HttpMethod, path: String): Option[(Endpoint[Op, _, _, _, _, _], HttpEndpoint[_], Map[String, String])]
final def httpMatch[Alg[_[_, _, _, _, _]], Op[_, _, _, _, _]](serviceProvider: Provider[Alg, Op], method: HttpMethod, pathSegments: Vector[String]): Option[(Endpoint[Op, _, _, _, _, _], 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.

Returns the first http endpoint that matches both a method and path, as well as the map of extracted segment values.

Attributes

Generated with
© 2002-2021 · LAMP/EPFL
© 2002-2021 · LAMP/EPFL