unidocs
0.23.27
API
Generated with
unidocs/org.http4s

org.http4s

package org.http4s

Members list

Packages

package org.http4s.circe
package org.http4s.client
package org.http4s.dsl
package org.http4s.ember
package org.http4s.h2
package org.http4s.headers
package org.http4s.internal
package org.http4s.jawn
package org.http4s.laws
package org.http4s.metrics
package org.http4s.multipart

This package is the start of a multipart implementation for http4s.

This package is the start of a multipart implementation for http4s. It is still deficient in a few ways:

- All encoding is chunked transfers, except for entities small enough to fit into the blaze buffer. This irritates some server implementations.

- When decoding, chunks are kept in memory. Large ones should be buffered to a temp file.

- It's a bit handwavy around character sets. Things probably go horribly wrong if you're not UTF-8.

- This module is lightly tested, and its API should be considered experimental.

Enter this package at your own risk, but we'd love the feedback.

Attributes

package org.http4s.server
package org.http4s.syntax
package org.http4s.testing
package org.http4s.util
package org.http4s.websocket

Type members

Classlikes

object AuthScheme

Attributes

Source
AuthScheme.scala
Supertypes
class Object
trait Matchable
class Any
Self type
AuthScheme.type
object AuthedRequest

Attributes

Source
AuthedRequest.scala
Supertypes
class Object
trait Matchable
class Any
Self type
object AuthedRoutes

Attributes

Source
AuthedRoutes.scala
Supertypes
class Object
trait Matchable
class Any
Self type
final case class BasicCredentials(username: String, password: String, charset: Charset)

Attributes

Companion
object
Source
Credentials.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object BasicCredentials

Attributes

Companion
class
Source
Credentials.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case object BuildInfo

This object was generated by sbt-buildinfo.

This object was generated by sbt-buildinfo.

Attributes

Source
BuildInfo.scala
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type
BuildInfo.type
sealed trait CacheDirective extends Product, Renderable

Attributes

Companion
object
Source
CacheDirective.scala
Supertypes
trait Renderable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
class `private`
class max-age
class max-stale
class min-fresh
class no-cache
object no-store
object no-transform
object public
class s-maxage
Show all
object CacheDirective

A registry of cache-directives, as listed in http://www.iana.org/assignments/http-cache-directives/http-cache-directives.xhtml

A registry of cache-directives, as listed in http://www.iana.org/assignments/http-cache-directives/http-cache-directives.xhtml

Attributes

Companion
trait
Source
CacheDirective.scala
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class Challenge(scheme: String, realm: String, params: Map[String, String]) extends Renderable

Attributes

Source
Challenge.scala
Supertypes
trait Serializable
trait Product
trait Equals
trait Renderable
class Object
trait Matchable
class Any
Show all
final case class Charset extends Renderable

Attributes

Companion
object
Source
Charset.scala
Supertypes
trait Serializable
trait Product
trait Equals
trait Renderable
class Object
trait Matchable
class Any
Show all
object Charset

Attributes

Companion
class
Source
Charset.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Charset.type
sealed abstract class CharsetRange extends HasQValue, Renderable

Attributes

Companion
object
Source
CharsetRange.scala
Supertypes
trait Renderable
trait HasQValue
class Object
trait Matchable
class Any
Known subtypes
class *
object *
class Atom
object CharsetRange

Attributes

Companion
class
Source
CharsetRange.scala
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
trait ClientTypes

Attributes

Source
package.scala
Supertypes
class Object
trait Matchable
class Any
class ContentCoding extends HasQValue, Ordered[ContentCoding], Renderable

Attributes

Companion
object
Source
ContentCoding.scala
Supertypes
trait Renderable
trait HasQValue
class Object
trait Matchable
class Any
Show all
object ContentCoding

Attributes

Companion
class
Source
ContentCoding.scala
Supertypes
class Object
trait Matchable
class Any
Self type
final case class ContextRequest[F[_], A](context: A, req: Request[F])

Attributes

Companion
object
Source
ContextRequest.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ContextRequest

Attributes

Companion
class
Source
ContextRequest.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class ContextResponse[F[_], A](context: A, response: Response[F])

Attributes

Companion
object
Source
ContextResponse.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ContextResponse

Attributes

Companion
class
Source
ContextResponse.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
object ContextRoutes

Attributes

Source
ContextRoutes.scala
Supertypes
class Object
trait Matchable
class Any
Self type
sealed abstract class Credentials extends Renderable

Attributes

Companion
object
Source
Credentials.scala
Supertypes
trait Renderable
class Object
trait Matchable
class Any
Known subtypes
class AuthParams
class Token
object Credentials

Attributes

Companion
class
Source
Credentials.scala
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
trait DecodeFailure extends MessageFailure

Indicates a problem decoding a Message.

Indicates a problem decoding a Message. This may either be a problem with the entity headers or with the entity itself.

Attributes

Companion
object
Source
MessageFailure.scala
Supertypes
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
Known subtypes
Show all
object DecodeFailure

Attributes

Companion
trait
Source
MessageFailure.scala
Supertypes
class Object
trait Matchable
class Any
Self type
object DecodeResult

Attributes

Source
DecodeResult.scala
Supertypes
class Object
trait Matchable
class Any
Self type
final case class Entity[+F[_]](body: EntityBody[F], length: Option[Long])

Attributes

Companion
object
Source
Entity.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Entity

Attributes

Companion
class
Source
Entity.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Entity.type
trait EntityDecoder[F[_], T]

A type that can be used to decode a Message EntityDecoder is used to attempt to decode a Message returning the entire resulting A.

A type that can be used to decode a Message EntityDecoder is used to attempt to decode a Message returning the entire resulting A. If an error occurs it will result in a failed effect. The default decoders provided here are not streaming, but one could implement a streaming decoder by having the value of A be some kind of streaming construct.

Type parameters

T

result type produced by the decoder

Attributes

Companion
object
Source
EntityDecoder.scala
Supertypes
class Object
trait Matchable
class Any
Self type
object EntityDecoder

EntityDecoder is used to attempt to decode an EntityBody This companion object provides a way to create new EntityDecoders along with some commonly used instances which can be resolved implicitly.

EntityDecoder is used to attempt to decode an EntityBody This companion object provides a way to create new EntityDecoders along with some commonly used instances which can be resolved implicitly.

Attributes

Companion
trait
Source
EntityDecoder.scala
Supertypes
class Object
trait Matchable
class Any
Self type
trait EntityEncoder[F[_], A]

Attributes

Companion
object
Source
EntityEncoder.scala
Supertypes
class Object
trait Matchable
class Any
Self type
object EntityEncoder

Attributes

Companion
trait
Source
EntityEncoder.scala
Supertypes
class Object
trait Matchable
class Any
Self type
final case class EntityTag(tag: String, weakness: Weakness) extends Renderable

Attributes

Companion
object
Source
EntityTag.scala
Supertypes
trait Serializable
trait Product
trait Equals
trait Renderable
class Object
trait Matchable
class Any
Show all
object EntityTag

Attributes

Companion
class
Source
EntityTag.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
EntityTag.type
sealed trait FormDataDecoder[A]

A decoder ware that uses QueryParamDecoder to decode values in org.http4s.UrlForm

A decoder ware that uses QueryParamDecoder to decode values in org.http4s.UrlForm

Attributes

Example 

scala> import cats.syntax.all._
scala> import cats.data._
scala> import org.http4s.FormDataDecoder._
scala> case class Foo(a: String, b: Boolean)
scala> case class Bar(fs: List[Foo], f: Foo, d: Boolean)
scala>
scala> implicit val fooMapper: FormDataDecoder[Foo] = (
    |   field[String]("a"),
    |   field[Boolean]("b")
    | ).mapN(Foo.apply)
scala>
scala> val barMapper = (
    |   list[Foo]("fs"),
    |   nested[Foo]("f"),
    |   field[Boolean]("d")
    | ).mapN(Bar.apply)
scala>
scala> barMapper(
    |   Map(
    |    "fs[].a" -> Chain("a1", "a2"),
    |    "fs[].b" -> Chain("true", "false"),
    |    "f.a" -> Chain("fa"),
    |    "f.b" -> Chain("false"),
    |    "d" -> Chain("true"))
    | )
res1: ValidatedNel[ParseFailure, Bar] = Valid(Bar(List(Foo(a1,true), Foo(a2,false)),Foo(fa,false),true))

The companion object provides a EntityDecoder from HTML form parameters.

import org.http4s.FormDataDecoder.formEntityDecoder
HttpRoutes
 .of[F] {
   case req @ POST -> Root =>
     req.as[MyEntity].flatMap { entity =>
       Ok()
     }
 }

For more examples, check the tests https://github.com/http4s/http4s/blob/main/tests/src/test/scala/org/http4s/FormDataDecoderSpec.scala

Companion
object
Source
FormDataDecoder.scala
Supertypes
class Object
trait Matchable
class Any
object FormDataDecoder

Attributes

Companion
trait
Source
FormDataDecoder.scala
Supertypes
class Object
trait Matchable
class Any
Self type
trait HasQValue

Attributes

Source
QValue.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class CharsetRange
class *
object *
class Atom
trait Header[A, T <: Type]

Typeclass representing an HTTP header, which all the http4s default headers satisfy.

Typeclass representing an HTTP header, which all the http4s default headers satisfy. You can add modelled headers by providing an implicit instance of Header[YourModelledHeader]

Attributes

Companion
object
Source
Header.scala
Supertypes
class Object
trait Matchable
class Any
object Header

Attributes

Companion
trait
Source
Header.scala
Supertypes
class Object
trait Matchable
class Any
Self type
Header.type
final class Headers(val headers: List[Raw]) extends AnyVal

A collection of HTTP Headers

A collection of HTTP Headers

Attributes

Companion
object
Source
Headers.scala
Supertypes
class AnyVal
trait Matchable
class Any
object Headers

Attributes

Companion
class
Source
Headers.scala
Supertypes
class Object
trait Matchable
class Any
Self type
Headers.type
object Http

Functions for creating Http kleislis.

Functions for creating Http kleislis.

Attributes

Source
Http.scala
Supertypes
class Object
trait Matchable
class Any
Self type
Http.type
trait Http4sLawSuite extends ScalaCheckEffectSuite

Poor's man discipline runner to check a set of PropF[F]

Poor's man discipline runner to check a set of PropF[F]

Attributes

Source
Http4sLawSuite.scala
Supertypes
trait ScalaCheckSuite
class FunSuite
trait BaseFunSuite
trait ValueTransforms
trait SuiteTransforms
trait TestTransforms
trait TestOptionsConversions
trait FunFixtures
trait Assertions
trait CompileErrorMacro
class Suite
trait PlatformSuite
class Object
trait Matchable
class Any
Show all
trait Http4sSuite extends CatsEffectSuite, DisciplineSuite, ScalaCheckEffectSuite, Http4sSuitePlatform

Common stack for http4s' munit based tests

Common stack for http4s' munit based tests

Attributes

Source
Http4sSuite.scala
Supertypes
trait ScalaCheckSuite
class FunSuite
trait BaseFunSuite
trait ValueTransforms
trait SuiteTransforms
trait TestTransforms
trait TestOptionsConversions
trait FunFixtures
trait Assertions
trait CompileErrorMacro
class Suite
trait PlatformSuite
class Object
trait Matchable
class Any
Show all
trait Http4sSuitePlatform

Attributes

Source
Http4sSuitePlatform.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait Http4sSuite
Self type
final case class Http4sVersion(major: Int, minor: Int)

Attributes

Source
Http4sVersion.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object HttpApp

Functions for creating HttpApp kleislis.

Functions for creating HttpApp kleislis.

Attributes

Source
HttpApp.scala
Supertypes
class Object
trait Matchable
class Any
Self type
HttpApp.type
trait HttpCodec[A] extends Renderer[A]

Attributes

Companion
object
Source
HttpCodec.scala
Supertypes
trait Renderer[A]
class Object
trait Matchable
class Any
object HttpCodec

Attributes

Companion
trait
Source
HttpCodec.scala
Supertypes
class Object
trait Matchable
class Any
Self type
HttpCodec.type
class HttpDate extends Renderable, Ordered[HttpDate]

An HTTP-date value represents time as an instance of Coordinated Universal Time (UTC).

An HTTP-date value represents time as an instance of Coordinated Universal Time (UTC). It expresses time at a resolution of one second. By using it over java.time.Instant in the model, we assure that if two headers render equally, their values are equal.

Attributes

See also
Companion
object
Source
HttpDate.scala
Supertypes
trait Ordered[HttpDate]
trait Renderable
class Object
trait Matchable
class Any
Show all
object HttpDate

Attributes

Companion
class
Source
HttpDate.scala
Supertypes
class Object
trait Matchable
class Any
Self type
HttpDate.type
object HttpRoutes

Functions for creating HttpRoutes kleislis.

Functions for creating HttpRoutes kleislis.

Attributes

Source
HttpRoutes.scala
Supertypes
class Object
trait Matchable
class Any
Self type
HttpRoutes.type
final case class HttpVersion extends Renderable, Ordered[HttpVersion]

HTTP's version number consists of two decimal digits separated by a "." (period or decimal point).

HTTP's version number consists of two decimal digits separated by a "." (period or decimal point). The first digit ("major version") indicates the messaging syntax, whereas the second digit ("minor version") indicates the highest minor version within that major version to which the sender is conformant (able to understand for future communication).

Value parameters

major

The major version, 0 to 9 inclusive

minor

The minor version, 0 to 9 inclusive

Attributes

See also
Companion
object
Source
HttpVersion.scala
Supertypes
trait Serializable
trait Product
trait Equals
trait Renderable
class Object
trait Matchable
class Any
Show all
object HttpVersion

Attributes

Companion
class
Source
HttpVersion.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class InvalidBodyException(msg: String) extends Exception, NoStackTrace

Exception dealing with invalid body

Exception dealing with invalid body

Value parameters

msg

description if what makes the body invalid

Attributes

Source
InvalidBodyException.scala
Supertypes
trait Product
trait Equals
trait NoStackTrace
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
final case class InvalidMessageBodyFailure(details: String, cause: Option[Throwable]) extends MessageBodyFailure

Indicates a semantic error decoding the body of an HTTP Message.

Indicates a semantic error decoding the body of an HTTP Message.

Attributes

Source
MessageFailure.scala
Supertypes
trait Product
trait Equals
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
final case class InvalidResponseException(msg: String) extends Exception, NoStackTrace

Exception dealing with invalid response

Exception dealing with invalid response

Value parameters

msg

description if what makes the response invalid

Attributes

Source
InvalidResponseException.scala
Supertypes
trait Product
trait Equals
trait NoStackTrace
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
object LanguageTag

Attributes

Companion
class
Source
LanguageTag.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class LanguageTag(primaryTag: String, q: QValue, subTags: List[String]) extends Renderable

Attributes

Companion
object
Source
LanguageTag.scala
Supertypes
trait Serializable
trait Product
trait Equals
trait Renderable
class Object
trait Matchable
class Any
Show all
final case class MalformedMessageBodyFailure(details: String, cause: Option[Throwable]) extends MessageBodyFailure

Indicates an syntactic error decoding the body of an HTTP Message.

Indicates an syntactic error decoding the body of an HTTP Message.

Attributes

Source
MessageFailure.scala
Supertypes
trait Product
trait Equals
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
trait Media[F[_]]

Attributes

Companion
object
Source
Media.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Part[F]
trait Message[F]
class Request[F]
class Response[F]
object Media

Attributes

Companion
trait
Source
Media.scala
Supertypes
class Object
trait Matchable
class Any
Self type
Media.type
sealed class MediaRange

Attributes

Companion
object
Source
MediaType.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class MediaType
object MediaRange

Attributes

Companion
class
Source
MediaType.scala
Supertypes
class Object
trait Matchable
class Any
Self type
MediaRange.type
sealed class MediaType(mainType: String, val subType: String, val compressible: Boolean, val binary: Boolean, val fileExtensions: List[String], extensions: Map[String, String]) extends MediaRange

Attributes

Companion
object
Source
MediaType.scala
Supertypes
class MediaRange
class Object
trait Matchable
class Any
object MediaType

Attributes

Companion
class
Source
MediaType.scala
Supertypes
class Object
trait Matchable
class Any
Self type
MediaType.type
final case class MediaTypeMismatch(messageType: MediaType, expected: Set[MediaRange]) extends UnsupportedMediaTypeFailure

Indicates that no EntityDecoder matches the MediaType of the Message being decoded

Indicates that no EntityDecoder matches the MediaType of the Message being decoded

Attributes

Source
MessageFailure.scala
Supertypes
trait Product
trait Equals
trait NoStackTrace
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
final case class MediaTypeMissing(expected: Set[MediaRange]) extends UnsupportedMediaTypeFailure

Indicates that a Message attempting to be decoded has no MediaType and no EntityDecoder was lenient enough to accept it.

Indicates that a Message attempting to be decoded has no MediaType and no EntityDecoder was lenient enough to accept it.

Attributes

Source
MessageFailure.scala
Supertypes
trait Product
trait Equals
trait NoStackTrace
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
sealed trait Message[F[_]] extends Media[F]

Represents a HTTP Message.

Represents a HTTP Message. The interesting subclasses are Request and Response.

Attributes

Companion
object
Source
Message.scala
Supertypes
trait Media[F]
class Object
trait Matchable
class Any
Known subtypes
class Request[F]
class Response[F]
Self type
Message[F]
object Message

Attributes

Companion
trait
Source
Message.scala
Supertypes
class Object
trait Matchable
class Any
Self type
Message.type
trait MessageBodyFailure extends DecodeFailure

Indicates a problem decoding a Message body.

Indicates a problem decoding a Message body.

Attributes

Source
MessageFailure.scala
Supertypes
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
Known subtypes
trait MessageFailure extends RuntimeException

Indicates a failure to handle an HTTP Message.

Indicates a failure to handle an HTTP Message.

Attributes

Source
MessageFailure.scala
Supertypes
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
Known subtypes
class ParseFailure
Show all
final class Method extends Renderable, Serializable

An HTTP method.

An HTTP method.

Value parameters

isIdempotent

A request method is considered "idempotent" if the intended effect on the server of multiple identical requests with that method is the same as the effect for a single such request.

isSafe

Request methods are considered "safe" if their defined semantics are essentially read-only; i.e., the client does not request, and does not expect, any state change on the origin server as a result of applying a safe method to a target resource.

name

The name of the method

Attributes

See also
Companion
object
Source
Method.scala
Supertypes
trait Serializable
trait Renderable
class Object
trait Matchable
class Any
object Method

Attributes

Companion
class
Source
Method.scala
Supertypes
class Object
trait Matchable
class Any
Self type
Method.type
final case class ParseFailure(sanitized: String, details: String) extends MessageFailure, NoStackTrace

Indicates an error parsing an HTTP Message.

Indicates an error parsing an HTTP Message.

Value parameters

details

Contains any relevant details omitted from the sanitized version of the error. This may freely echo a Request.

sanitized

May safely be displayed to a client to describe an error condition. Should not echo any part of a Request.

Attributes

Companion
object
Source
MessageFailure.scala
Supertypes
trait Product
trait Equals
trait NoStackTrace
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
object ParseFailure

Attributes

Companion
class
Source
MessageFailure.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
object ParseResult

Attributes

Source
MessageFailure.scala
Supertypes
class Object
trait Matchable
class Any
Self type
final case class ProductComment(value: String) extends ProductIdOrComment

Attributes

Companion
object
Source
ProductIdOrComment.scala
Supertypes
trait Serializable
trait Product
trait Equals
trait Renderable
class Object
trait Matchable
class Any
Show all
object ProductComment

Attributes

Companion
class
Source
ProductIdOrComment.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class ProductId(value: String, version: Option[String]) extends ProductIdOrComment

Attributes

Companion
object
Source
ProductIdOrComment.scala
Supertypes
trait Serializable
trait Product
trait Equals
trait Renderable
class Object
trait Matchable
class Any
Show all
object ProductId

Attributes

Companion
class
Source
ProductIdOrComment.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
ProductId.type
sealed trait ProductIdOrComment extends Renderable

Attributes

Companion
object
Source
ProductIdOrComment.scala
Supertypes
trait Renderable
class Object
trait Matchable
class Any
Known subtypes
class ProductId
object ProductIdOrComment

Attributes

Companion
trait
Source
ProductIdOrComment.scala
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class Protocol(name: CIString, version: Option[CIString])

Attributes

Companion
object
Source
Protocol.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Protocol

Attributes

Companion
class
Source
Protocol.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Protocol.type
final class QValue extends AnyVal, Ordered[QValue]

A Quality Value.

A Quality Value. Represented as thousandths for an exact representation rounded to three decimal places.

Value parameters

thousandths

between 0 (for q=0) and 1000 (for q=1)

Attributes

See also
Companion
object
Source
QValue.scala
Supertypes
trait Ordered[QValue]
class Object
class AnyVal
trait Matchable
class Any
Show all
object QValue extends QValuePlatform

Attributes

Companion
class
Source
QValue.scala
Supertypes
class Object
trait Matchable
class Any
Self type
QValue.type
trait QValuePlatform

Attributes

Source
QValuePlatform.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object QValue
final class Query extends QueryOps, Renderable

Collection representation of a query string

Collection representation of a query string

It is a indexed sequence of key and maybe a value pairs which maps precisely to a query string, modulo percent-encoding.

When rendered, the resulting String will have the pairs separated by '&' while the key is separated from the value with '='

Attributes

Companion
object
Source
Query.scala
Supertypes
trait Renderable
trait QueryOps
class Object
trait Matchable
class Any
object Query

Attributes

Companion
class
Source
Query.scala
Supertypes
class Object
trait Matchable
class Any
Self type
Query.type
trait QueryOps

Attributes

Source
QueryOps.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Query
class Uri
trait QueryParam[T] extends QueryParamKeyLike[T]

type class defining the key of a query parameter Usually used in conjunction with QueryParamEncoder and QueryParamDecoder

type class defining the key of a query parameter Usually used in conjunction with QueryParamEncoder and QueryParamDecoder

Any QueryParam instance is also a valid QueryParamKeyLike instance where the same key is used for all values.

Attributes

Companion
object
Source
QueryParam.scala
Supertypes
class Object
trait Matchable
class Any
object QueryParam

Attributes

Companion
trait
Source
QueryParam.scala
Supertypes
class Object
trait Matchable
class Any
Self type
QueryParam.type
trait QueryParamCodec[T] extends QueryParamEncoder[T], QueryParamDecoder[T]

Attributes

Companion
object
Source
QueryParam.scala
Supertypes
class Object
trait Matchable
class Any
object QueryParamCodec

Attributes

Companion
trait
Source
QueryParam.scala
Supertypes
class Object
trait Matchable
class Any
Self type
trait QueryParamDecoder[T]

Type class defining how to decode a QueryParameterValue into a T

Type class defining how to decode a QueryParameterValue into a T

Attributes

See also

QueryParamCodecLaws

Companion
object
Source
QueryParam.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait QueryParamCodec[T]
Self type
object QueryParamDecoder

Attributes

Companion
trait
Source
QueryParam.scala
Supertypes
class Object
trait Matchable
class Any
Self type
trait QueryParamEncoder[T]

Type class defining how to encode a T as a QueryParameterValues

Type class defining how to encode a T as a QueryParameterValues

Attributes

See also

QueryParamCodecLaws

Companion
object
Source
QueryParam.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait QueryParamCodec[T]
Self type
object QueryParamEncoder

Attributes

Companion
trait
Source
QueryParam.scala
Supertypes
class Object
trait Matchable
class Any
Self type
trait QueryParamKeyLike[T]

Attributes

Companion
object
Source
QueryParam.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait QueryParam[T]
object QueryParamKeyLike

Attributes

Companion
trait
Source
QueryParam.scala
Supertypes
class Object
trait Matchable
class Any
Self type
final case class QueryParameterKey(value: String) extends AnyVal

Attributes

Companion
object
Source
QueryParam.scala
Supertypes
trait Serializable
trait Product
trait Equals
class AnyVal
trait Matchable
class Any
Show all
object QueryParameterKey

Attributes

Companion
class
Source
QueryParam.scala
Supertypes
class Object
trait Matchable
class Any
Self type
final case class QueryParameterValue(value: String) extends AnyVal

Attributes

Companion
object
Source
QueryParam.scala
Supertypes
trait Serializable
trait Product
trait Equals
class AnyVal
trait Matchable
class Any
Show all
object QueryParameterValue

Attributes

Companion
class
Source
QueryParam.scala
Supertypes
class Object
trait Matchable
class Any
Self type
object RangeUnit

Attributes

Companion
class
Source
RangeUnit.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
RangeUnit.type
final case class RangeUnit(value: String) extends Renderable

Attributes

Companion
object
Source
RangeUnit.scala
Supertypes
trait Serializable
trait Product
trait Equals
trait Renderable
class Object
trait Matchable
class Any
Show all
final class Request[F[_]] extends Message[F], Product, Serializable

Representation of an incoming HTTP message

Representation of an incoming HTTP message

A Request encapsulates the entirety of the incoming HTTP request including the status line, headers, and a possible request body.

Value parameters

attributes

Immutable Map used for carrying additional information in a type safe fashion

body

fs2.Stream[F, Byte] defining the body of the request

headers

collection of Headers

httpVersion

the HTTP version

method

Method.GET, Method.POST, etc.

uri

representation of the request URI

Attributes

Companion
object
Source
Message.scala
Supertypes
trait Serializable
trait Product
trait Equals
trait Message[F]
trait Media[F]
class Object
trait Matchable
class Any
Show all
object Request

Attributes

Companion
class
Source
Message.scala
Supertypes
class Object
trait Matchable
class Any
Self type
Request.type
final case class RequestCookie(name: String, content: String) extends Renderable

Attributes

Companion
object
Source
RequestCookie.scala
Supertypes
trait Serializable
trait Product
trait Equals
trait Renderable
class Object
trait Matchable
class Any
Show all
object RequestCookie

Attributes

Companion
class
Source
RequestCookie.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed abstract class RequestPrelude extends Product, Serializable

A projection of a Request without the body.

A projection of a Request without the body.

Attributes

Note

The Request#attributes are omitted in this encoding because they do not (and can not) have a cats.kernel.Order instance. If they were included here, then we could not write a cats.kernel.Order instance for RequestPrelude, limiting some of its utility, e.g. it could not be used in a cats.data.NonEmptySet.

Companion
object
Source
RequestPrelude.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object RequestPrelude

Attributes

Companion
class
Source
RequestPrelude.scala
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
final class Response[F[_]] extends Message[F], Product, Serializable

Representation of the HTTP response to send back to the client

Representation of the HTTP response to send back to the client

Value parameters

attributes

org.typelevel.vault.Vault containing additional parameters which may be used by the http4s backend for additional processing such as java.io.File object

body

EntityBody[F] representing the possible body of the response

headers

Headers containing all response headers

status

Status code and message

Attributes

Companion
object
Source
Message.scala
Supertypes
trait Serializable
trait Product
trait Equals
trait Message[F]
trait Media[F]
class Object
trait Matchable
class Any
Show all
object Response extends KleisliSyntax

Attributes

Companion
class
Source
Message.scala
Supertypes
class Object
trait Matchable
class Any
Self type
Response.type
final case class ResponseCookie(name: String, content: String, expires: Option[HttpDate], maxAge: Option[Long], domain: Option[String], path: Option[String], sameSite: Option[SameSite], secure: Boolean, httpOnly: Boolean, extension: Option[String]) extends Renderable

Value parameters

extension

The extension attributes of the cookie. If there is more than one, they are joined by semi-colon, which must not appear in an attribute value.

Attributes

Companion
object
Source
ResponseCookie.scala
Supertypes
trait Serializable
trait Product
trait Equals
trait Renderable
class Object
trait Matchable
class Any
Show all
Self type
object ResponseCookie

Attributes

Companion
class
Source
ResponseCookie.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed abstract class ResponsePrelude extends Product, Serializable

A projection of a Response without the body.

A projection of a Response without the body.

Attributes

Note

The Response#attributes are omitted in this encoding because they do not (and can not) have a cats.kernel.Order instance. If they were included here, then we could not write a cats.kernel.Order instance for ResponsePrelude, limiting some of its utility, e.g. it could not be used in a cats.data.NonEmptySet.

Companion
object
Source
ResponsePrelude.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ResponsePrelude

Attributes

Companion
class
Source
ResponsePrelude.scala
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed trait SameSite extends Renderable

RFC6265 SameSite cookie attribute values.

RFC6265 SameSite cookie attribute values.

Attributes

Companion
object
Source
SameSite.scala
Supertypes
trait Renderable
class Object
trait Matchable
class Any
Known subtypes
object Lax
object None
object Strict
object SameSite

Attributes

Companion
trait
Source
SameSite.scala
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
SameSite.type
final case class ServerSentEvent(data: Option[String], eventType: Option[String], id: Option[EventId], retry: Option[FiniteDuration], comment: Option[String]) extends Renderable

Attributes

Companion
object
Source
ServerSentEvent.scala
Supertypes
trait Serializable
trait Product
trait Equals
trait Renderable
class Object
trait Matchable
class Any
Show all
object ServerSentEvent

Attributes

Companion
class
Source
ServerSentEvent.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class ServerSoftware(product: String, productVersion: Option[String], comment: Option[String])

Attributes

Companion
object
Source
ServerSoftware.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ServerSoftware

Attributes

Companion
class
Source
ServerSoftware.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
object StaticFile

Attributes

Source
StaticFile.scala
Supertypes
class Object
trait Matchable
class Any
Self type
StaticFile.type
sealed abstract case class Status extends Ordered[Status], Renderable

Representation of the HTTP response code and reason

Representation of the HTTP response code and reason

Note: the reason is not important to the protocol and is not considered in equality checks.

Value parameters

code

HTTP status code

reason

reason for the response. eg, OK

Attributes

See also
Companion
object
Source
Status.scala
Supertypes
trait Serializable
trait Product
trait Equals
trait Renderable
trait Ordered[Status]
class Object
trait Matchable
class Any
Show all
object Status

Attributes

Companion
class
Source
Status.scala
Supertypes
class Object
trait Matchable
class Any
Self type
Status.type
class TransferCoding extends Ordered[TransferCoding], Renderable

Attributes

Companion
object
Source
TransferCoding.scala
Supertypes
trait Renderable
class Object
trait Matchable
class Any
Show all
object TransferCoding

Attributes

Companion
class
Source
TransferCoding.scala
Supertypes
class Object
trait Matchable
class Any
Self type
sealed abstract class UnsupportedMediaTypeFailure extends DecodeFailure, NoStackTrace

Indicates that a Message came with no supported MediaType.

Indicates that a Message came with no supported MediaType.

Attributes

Source
MessageFailure.scala
Supertypes
trait NoStackTrace
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
Known subtypes
final case class Uri(scheme: Option[Scheme], authority: Option[Authority], path: Path, query: Query, fragment: Option[Fragment]) extends QueryOps, Renderable

Representation of the Request URI

Representation of the Request URI

Value parameters

authority

optional Uri Authority. eg, localhost:8080, www.foo.bar

fragment

optional Uri Fragment. url-encoded.

path

url-encoded string representation of the path component of the Uri.

query

optional Query. url-encoded.

scheme

optional Uri Scheme. eg, http, https

Attributes

Companion
object
Source
Uri.scala
Supertypes
trait Serializable
trait Product
trait Equals
trait Renderable
trait QueryOps
class Object
trait Matchable
class Any
Show all
object Uri extends UriPlatform

Attributes

Companion
class
Source
Uri.scala
Supertypes
trait Product
trait Mirror
trait UriPlatform
class Object
trait Matchable
class Any
Show all
Self type
Uri.type
trait UriPlatform

Attributes

Source
UriPlatform.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Uri
final case class UriTemplate(scheme: Option[Scheme], authority: Option[Authority], path: Path, query: Query, fragment: Fragment)

Simple representation of a URI Template that can be rendered as RFC6570 conform string.

Simple representation of a URI Template that can be rendered as RFC6570 conform string.

This model reflects only a subset of RFC6570.

Level 1 and Level 2 are completely modeled and Level 3 features are limited to: - Path segments, slash-prefixed - Form-style query, ampersand-separated - Fragment expansion

Attributes

Companion
object
Source
UriTemplate.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object UriTemplate

Attributes

Companion
class
Source
UriTemplate.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final class UrlForm extends AnyVal

Attributes

Companion
object
Source
UrlForm.scala
Supertypes
class AnyVal
trait Matchable
class Any
object UrlForm

Attributes

Companion
class
Source
UrlForm.scala
Supertypes
class Object
trait Matchable
class Any
Self type
UrlForm.type
case object WaitQueueTimeoutException extends TimeoutException

Attributes

Source
package.scala
Supertypes
trait Singleton
trait Product
trait Mirror
trait Product
trait Equals
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
object implicits extends AllSyntax

Attributes

Source
implicits.scala
Supertypes
trait AllSyntax
trait HeaderSyntax
trait StringSyntax
class Object
trait Matchable
class Any
Show all
Self type
implicits.type

Deprecated classlikes

trait MediaTypePlaform

Attributes

Deprecated
true
Source
MediaTypePlaform.scala
Supertypes
class Object
trait Matchable
class Any
object RequestCookieJar

Attributes

Companion
class
Deprecated
true
Source
RequestCookieJar.scala
Supertypes
class Object
trait Matchable
class Any
Self type
final class RequestCookieJar extends AnyVal

Attributes

Companion
object
Deprecated
true
Source
RequestCookieJar.scala
Supertypes
class AnyVal
trait Matchable
class Any

Types

type AuthScheme = CIString

Attributes

Source
package.scala
type AuthedRequest[F[_], T] = ContextRequest[F, T]

Attributes

Source
package.scala
type AuthedRoutes[T, F[_]] = Kleisli[[_] =>> OptionT[F, _$10], ContextRequest[F, T], Response[F]]

The type parameters need to be in this order to make partial unification trigger.

The type parameters need to be in this order to make partial unification trigger. See https://github.com/http4s/http4s/issues/1506

Attributes

Source
package.scala
type Callback[A] = (Either[Throwable, A]) => Unit

Attributes

Source
package.scala
type ContextRoutes[T, F[_]] = Kleisli[[_] =>> OptionT[F, _$12], ContextRequest[F, T], Response[F]]

Attributes

Source
package.scala
type DecodeResult[F[_], A] = EitherT[F, DecodeFailure, A]

Attributes

Source
package.scala
type EntityBody[+F[_]] = Stream[F, Byte]

Attributes

Source
package.scala
type EventStream[F[_]] = Stream[F, ServerSentEvent]

A stream of server-sent events

A stream of server-sent events

Attributes

Source
package.scala
type Http[F[_], G[_]] = Kleisli[F, Request[G], Response[G]]

A kleisli with a Request input and a Response output.

A kleisli with a Request input and a Response output. This type is useful for writing middleware that are polymorphic over the return type F.

Type parameters

F

the effect type in which the Response is returned

G

the effect type of the Request and Response bodies

Attributes

Source
package.scala
type HttpApp[F[_]] = Http[F, F]

A kleisli with a Request input and a Response output, such that the response effect is the same as the request and response bodies'.

A kleisli with a Request input and a Response output, such that the response effect is the same as the request and response bodies'. An HTTP app is total on its inputs. An HTTP app may be run by a server, and a client can be converted to or from an HTTP app.

Type parameters

F

the effect type in which the Response is returned, and also of the Request and Response bodies.

Attributes

Source
package.scala
type HttpRoutes[F[_]] = Http[[_] =>> OptionT[F, _$7], F]

A kleisli with a Request input and a Response output, such that the response effect is an optional inside the effect of the request and response bodies.

A kleisli with a Request input and a Response output, such that the response effect is an optional inside the effect of the request and response bodies. HTTP routes can conveniently be constructed from a partial function and combined as a SemigroupK.

Type parameters

F

the effect type of the Request and Response bodies, and the base monad of the OptionT in which the response is returned.

Attributes

Source
package.scala
type ParseResult[+A] = Either[ParseFailure, A]

Attributes

Source
package.scala

Value members

Concrete fields

val ApiVersion: Http4sVersion

Attributes

Source
package.scala
val EmptyBody: EntityBody[Nothing]

Attributes

Source
package.scala

Deprecated fields

val DefaultCharset: Charset

Attributes

Deprecated
true
Source
package.scala
Generated with