Packages

abstract class DSL[F[_]] extends Http4sClientDsl[F]

Source
DSL.scala
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DSL
  2. Http4sClientDsl
  3. AnyRef
  4. Any
Implicitly
  1. by StringFormat
  2. by Ensuring
  3. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new DSL()(implicit client: Client[F], F: Concurrent[F])

Type Members

  1. type /=>[-T, +R] = PartialFunction[T, R]
  2. type EntityDecoderF[T] = EntityDecoder[F, T]

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def ->[B](y: B): (DSL[F], B)
    Implicit
    This member is added by an implicit conversion from DSL[F] toArrowAssoc[DSL[F]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. val LIST: Method
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  8. def defaultErrorHandler[A](request: Request[F])(onErrorsPF: /=>[List[String], F[A]]): (Response[F]) => F[A]

    If a BadRequest is returned its body will be decoded to a List[String] and the onErrorPF will be invoked.

    If a BadRequest is returned its body will be decoded to a List[String] and the onErrorPF will be invoked. Allowing to recover for some errors. Otherwise an error will be raised with UnexpectedStatus.

    onErrorsPF

    the PartialFunction to apply to the BadRequest errors.

  9. def defaultOnError[R](request: Request[F], response: Response[F]): F[R]
    Attributes
    protected
  10. def ensuring(cond: (DSL[F]) => Boolean, msg: => Any): DSL[F]
    Implicit
    This member is added by an implicit conversion from DSL[F] toEnsuring[DSL[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: (DSL[F]) => Boolean): DSL[F]
    Implicit
    This member is added by an implicit conversion from DSL[F] toEnsuring[DSL[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean, msg: => Any): DSL[F]
    Implicit
    This member is added by an implicit conversion from DSL[F] toEnsuring[DSL[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean): DSL[F]
    Implicit
    This member is added by an implicit conversion from DSL[F] toEnsuring[DSL[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  16. def execute[A](request: Request[F])(implicit d: EntityDecoderF[A]): F[A]

    Executes a request, and on a successful response decodes the body to an A.

    Executes a request, and on a successful response decodes the body to an A. On any other response defaultErrorHandler will be called.

    A

    the type to which the response will be decoded to.

    request

    the request to execute.

  17. def executeOption[A](request: Request[F])(implicit d: EntityDecoderF[A]): F[Option[A]]

    Executes a request, and on a successful response decodes the body to an A inside a Some.

    Executes a request, and on a successful response decodes the body to an A inside a Some. On a NotFound or Gone response returns a None. On any other response defaultErrorHandler will be called.

    A

    the type to which the response will be decoded to.

    request

    the request to execute.

  18. def executeOptionWithContextData[Data](request: Request[F])(implicit decoder: EntityDecoder[F, Context[Data]]): F[Option[Data]]

    Executes a request for an endpoint which returns Option[Context[Data]] but we are only interested in the Context data.

    Executes a request for an endpoint which returns Option[Context[Data]] but we are only interested in the Context data.

    Data

    the type we are interested in.

    request

    the request for the endpoint

  19. def executeWithContextAuth(request: Request[F]): F[Auth]

    Executes a request for an endpoint which returns Context[_] but we are only interested in the Auth.

    Executes a request for an endpoint which returns Context[_] but we are only interested in the Auth.

    request

    the request for the endpoint

  20. def executeWithContextData[Data](request: Request[F])(implicit decoder: EntityDecoder[F, Context[Data]]): F[Data]

    Executes a request for an endpoint which returns Context[Data] but we are only interested in its data.

    Executes a request for an endpoint which returns Context[Data] but we are only interested in its data.

    Data

    the type we are interested in.

    request

    the request for the endpoint

  21. def executeWithContextKeys(request: Request[F])(implicit decoder: EntityDecoder[F, Context[Keys]]): F[List[String]]

    Executes a request for an endpoint which returns Context[Keys] but we are only interested in the keys.

    Executes a request for an endpoint which returns Context[Keys] but we are only interested in the keys.

    request

    the request for the endpoint

  22. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from DSL[F] toStringFormat[DSL[F]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  23. def genericExecute[A](request: Request[F])(f: /=>[Response[F], F[A]], onErrorsPF: /=>[List[String], F[A]] = PartialFunction.empty): F[A]

    Execute the given request, and apply the partial function f to the response.

    Execute the given request, and apply the partial function f to the response. If f is not defined for some response the defaultErrorHandler will be called with onErrorsPF

    request

    the request to execute.

    onErrorsPF

    the PartialFunction to apply on the BadRequest errors.

  24. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  25. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  26. implicit def http4sClientSyntaxMethod(method: Method): MethodOps[F]
    Definition Classes
    Http4sClientDsl
  27. implicit def http4sHeadersDecoder[T](implicit F: Applicative[F], decoder: EntityDecoder[F, T]): EntityDecoder[F, (Headers, T)]
    Definition Classes
    Http4sClientDsl
  28. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  29. implicit def jsonDecoder[A](implicit arg0: Decoder[A]): EntityDecoder[F, A]
  30. implicit def jsonEncoder[A](implicit arg0: Encoder[A]): EntityEncoder[F, A]
  31. val jsonPrinter: Printer
  32. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  33. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  34. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  35. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  36. def toString(): String
    Definition Classes
    AnyRef → Any
  37. implicit def void: EntityDecoder[F, Unit]
  38. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  39. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  40. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated
  2. def [B](y: B): (DSL[F], B)
    Implicit
    This member is added by an implicit conversion from DSL[F] toArrowAssoc[DSL[F]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from Http4sClientDsl[F]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion StringFormat fromDSL[F] to StringFormat[DSL[F]]

Inherited by implicit conversion Ensuring fromDSL[F] to Ensuring[DSL[F]]

Inherited by implicit conversion ArrowAssoc fromDSL[F] to ArrowAssoc[DSL[F]]

Ungrouped