algebra
API
Generated with
algebra/endpoints4s/endpoints4s.algebra/Responses

Responses

endpoints4s.algebra.Responses
trait Responses extends StatusCodes, InvariantFunctorSyntax

Attributes

Graph
Supertypes
trait StatusCodes
class Object
trait Matchable
class Any
Known subtypes
trait Assets
trait Endpoints
trait JsonEntities
trait JsonCodecs
trait MuxEndpoints
Show all
Self type

Members list

Type members

Classlikes

implicit class ResponseSyntax[A](response: Response[A])

Extension methods for Response.

Extension methods for Response.

Attributes

Supertypes
class Object
trait Matchable
class Any

Inherited classlikes

implicit class InvariantFunctorSyntax[A, F[_]](val fa: F[A])(implicit ev: InvariantFunctor[F])

Extension methods for values of type F[A] for which there is an implicit InvariantFunctor[F] instance.

Extension methods for values of type F[A] for which there is an implicit InvariantFunctor[F] instance.

Attributes

Inherited from:
InvariantFunctorSyntax
Supertypes
class Object
trait Matchable
class Any

Types

type Response[A]

An HTTP response (status, headers, and entity) carrying an information of type A

An HTTP response (status, headers, and entity) carrying an information of type A

Values of type Response[A] can be constructed by using the operations ok, badRequest, internalServerError, or the more general operation response.

Attributes

Note

This type has implicit methods provided by the InvariantFunctorSyntax and ResponseSyntax classes

type ResponseEntity[A]

An HTTP response entity carrying an information of type A

An HTTP response entity carrying an information of type A

Values of type ResponseEntity can be constructed by using the operations emptyResponse or textResponse. Additional types of response entities are provided by other algebra modules, such as JsonEntities or ChunkedEntities.

Attributes

Note

This type has implicit methods provided by the InvariantFunctorSyntax class

type ResponseHeaders[A]

Information carried by responses’ headers.

Information carried by responses’ headers.

You can construct values of type ResponseHeaders by using the operations responseHeader, optResponseHeader, or emptyResponseHeaders.

Attributes

Note

This type has implicit methods provided by the SemigroupalSyntax and InvariantFunctorSyntax classes.

Inherited types

type StatusCode

HTTP Status Code

HTTP Status Code

Attributes

Inherited from:
StatusCodes

Value members

Abstract methods

def choiceResponse[A, B](responseA: Response[A], responseB: Response[B]): Response[Either[A, B]]

Alternative between two possible choices of responses.

Alternative between two possible choices of responses.

Server interpreters construct either one or the other response. Client interpreters accept either one or the other response. Documentation interpreters list all the possible responses.

Attributes

def emptyResponse: ResponseEntity[Unit]

Empty response entity

Empty response entity

  • Server interpreters produce no response entity,
  • Client interpreters ignore the response entity.

Attributes

def emptyResponseHeaders: ResponseHeaders[Unit]

No particular response header.

No particular response header.

  • Client interpreters should ignore information carried by response headers.

Attributes

def optResponseHeader(name: String, docs: Documentation): ResponseHeaders[Option[String]]

Response headers optionally containing a header with the given name.

Response headers optionally containing a header with the given name.

  • Client interpreters should model the header value as Some[String], or None if the response header is missing.
  • Server interpreters should produce such a response header.
  • Documentation interpreters should document this header.

Attributes

def response[A, B, R](statusCode: StatusCode, entity: ResponseEntity[A], docs: Documentation, headers: ResponseHeaders[B])(implicit tupler: Aux[A, B, R]): Response[R]

Define an HTTP response

Define an HTTP response

  • Server interpreters construct a response with the given status and entity.
  • Client interpreters accept a response only if it has a corresponding status code.

Value parameters

docs

Response documentation

entity

Response entity

headers

Response headers

statusCode

Response status code

Attributes

def responseHeader(name: String, docs: Documentation): ResponseHeaders[String]

Response headers containing a header with the given name.

Response headers containing a header with the given name.

  • Client interpreters should model the header value as String, or fail if the response header is missing.
  • Server interpreters should produce such a response header.
  • Documentation interpreters should document this header.

Example:

 val versionedResource: Endpoint[Unit, (SomeResource, String)] =
   endpoint(
     get(path / "versioned-resource"),
     ok(
       jsonResponse[SomeResource],
       headers = responseHeader("ETag")
     )
   )

Attributes

def textResponse: ResponseEntity[String]

Text response entity

Text response entity

  • Server interpreters produce an HTTP response with a text/plain content type.

Attributes

Concrete methods

def addResponseHeaders[A, H](response: Response[A], headers: ResponseHeaders[H])(implicit tupler: Tupler[A, H]): Response[Out]

Add the provided headers to the response.

Add the provided headers to the response.

Note that if the response describes a choice of several possible responses (resulting from the orElse operation), the headers will be added to all the possible responses.

Attributes

final def badRequest[A, R](docs: Documentation, headers: ResponseHeaders[A])(implicit tupler: Aux[<none>, A, R]): Response[R]

Bad Request (400) response, with an entity of type ClientErrors.

Bad Request (400) response, with an entity of type ClientErrors.

Attributes

See also
final def internalServerError[A, R](docs: Documentation, headers: ResponseHeaders[A])(implicit tupler: Aux[<none>, A, R]): Response[R]

Internal Server Error (500) response, with an entity of type ServerError.

Internal Server Error (500) response, with an entity of type ServerError.

Attributes

See also
final def ok[A, B, R](entity: ResponseEntity[A], docs: Documentation, headers: ResponseHeaders[B])(implicit tupler: Aux[A, B, R]): Response[R]

OK (200) Response with the given entity

OK (200) Response with the given entity

Attributes

final def wheneverFound[A](responseA: Response[A], notFoundDocs: Documentation): Response[Option[A]]

Turns a Response[A] into a Response[Option[A]].

Turns a Response[A] into a Response[Option[A]].

Interpreters represent None with an empty HTTP response whose status code is 404 (Not Found).

Attributes

Inherited methods

def Accepted: StatusCode

Attributes

Inherited from:
StatusCodes
def AlreadyReported: StatusCode

Attributes

Inherited from:
StatusCodes
def BadRequest: StatusCode

Attributes

Note

You should use the badRequest constructor provided by the endpoints4s.algebra.Responses trait to ensure that errors produced by endpoints4s are consistently handled by interpreters.

Inherited from:
StatusCodes
def Conflict: StatusCode

Attributes

Inherited from:
StatusCodes
def Created: StatusCode

Attributes

Inherited from:
StatusCodes
def ExpectationFailed: StatusCode

Attributes

Inherited from:
StatusCodes
def FailedDependency: StatusCode

Attributes

Inherited from:
StatusCodes
def Forbidden: StatusCode

Attributes

Inherited from:
StatusCodes
def Gone: StatusCode

Attributes

Inherited from:
StatusCodes
def IMUsed: StatusCode

Attributes

Inherited from:
StatusCodes
def InternalServerError: StatusCode

Attributes

Note

You should use the internalServerError constructor provided by the endpoints4s.algebra.Responses trait to ensure that errors produced by endpoints4s are consistently handled by interpreters.

Inherited from:
StatusCodes
def LengthRequired: StatusCode

Attributes

Inherited from:
StatusCodes
def Locked: StatusCode

Attributes

Inherited from:
StatusCodes
def MethodNotAllowed: StatusCode

Attributes

Inherited from:
StatusCodes
def MisdirectedRequest: StatusCode

Attributes

Inherited from:
StatusCodes
def MultiStatus: StatusCode

Attributes

Inherited from:
StatusCodes
def NoContent: StatusCode

Attributes

Inherited from:
StatusCodes
def NonAuthoritativeInformation: StatusCode

Attributes

Inherited from:
StatusCodes
def NotAcceptable: StatusCode

Attributes

Inherited from:
StatusCodes
def NotFound: StatusCode

Attributes

Inherited from:
StatusCodes
def NotImplemented: StatusCode

Attributes

Inherited from:
StatusCodes
def NotModified: StatusCode

Attributes

Inherited from:
StatusCodes
def OK: StatusCode

Attributes

Inherited from:
StatusCodes
def PartialContent: StatusCode

Attributes

Inherited from:
StatusCodes
def PayloadTooLarge: StatusCode

Attributes

Inherited from:
StatusCodes
def PaymentRequired: StatusCode

Attributes

Inherited from:
StatusCodes
def PermanentRedirect: StatusCode

Attributes

Inherited from:
StatusCodes
def PreconditionFailed: StatusCode

Attributes

Inherited from:
StatusCodes
def PreconditionRequired: StatusCode

Attributes

Inherited from:
StatusCodes
def ProxyAuthenticationRequired: StatusCode

Attributes

Inherited from:
StatusCodes
def RangeNotSatisfiable: StatusCode

Attributes

Inherited from:
StatusCodes
def RequestHeaderFieldsTooLarge: StatusCode

Attributes

Inherited from:
StatusCodes
def RequestTimeout: StatusCode

Attributes

Inherited from:
StatusCodes
def ResetContent: StatusCode

Attributes

Inherited from:
StatusCodes
def TemporaryRedirect: StatusCode

Attributes

Inherited from:
StatusCodes
def TooEarly: StatusCode

Attributes

Inherited from:
StatusCodes
def TooManyRequests: StatusCode

Attributes

Inherited from:
StatusCodes
def Unauthorized: StatusCode

Attributes

Inherited from:
StatusCodes
def UnavailableForLegalReasons: StatusCode

Attributes

Inherited from:
StatusCodes
def UnprocessableEntity: StatusCode

Attributes

Inherited from:
StatusCodes
def UnsupportedMediaType: StatusCode

Attributes

Inherited from:
StatusCodes
def UpgradeRequired: StatusCode

Attributes

Inherited from:
StatusCodes
def UriTooLong: StatusCode

Attributes

Inherited from:
StatusCodes

Implicits

Implicits

final implicit def ResponseSyntax[A](response: Response[A]): ResponseSyntax[A]

Extension methods for Response.

Extension methods for Response.

Attributes

implicit def responseHeadersInvariantFunctor: InvariantFunctor[ResponseHeaders]

Provides xmap operation.

Provides xmap operation.

Attributes

See also

InvariantFunctorSyntax

implicit def responseHeadersSemigroupal: Semigroupal[ResponseHeaders]

Provides ++ operation.

Provides ++ operation.

Attributes

See also
implicit def responseInvariantFunctor: InvariantFunctor[Response]

Provides the operation xmap to the type Response

Provides the operation xmap to the type Response

Attributes

See also

InvariantFunctorSyntax

Inherited implicits

final implicit def InvariantFunctorSyntax[A, F[_]](fa: F[A])(implicit ev: InvariantFunctor[F]): InvariantFunctorSyntax[A, F]

Extension methods for values of type F[A] for which there is an implicit InvariantFunctor[F] instance.

Extension methods for values of type F[A] for which there is an implicit InvariantFunctor[F] instance.

Attributes

Inherited from:
InvariantFunctorSyntax
Generated with