docs
API
Generated with
docs/zio.http/ZClient

ZClient

zio.http.ZClient
See theZClient companion object
trait ZClient[-Env, -In, +Err, +Out]

Attributes

Companion:
object
Graph
Supertypes
trait HeaderChecks[ZClient[Env, In, Err, Out]]
trait HeaderModifier[ZClient[Env, In, Err, Out]]
class Object
trait Matchable
class Any
Self type
ZClient[Env, In, Err, Out]

Members list

Concise view

Value members

Abstract methods

def headers: Headers

Returns the headers

Returns the headers

Attributes

def request(version: Version, method: Method, url: URL, headers: Headers, body: In, sslConfig: Option[ClientSSLConfig])(implicit trace: Trace): ZIO[Env, Err, Out]
def socket[Env1 <: Env](version: Version, url: URL, headers: Headers, app: SocketApp[Env1])(implicit trace: Trace): ZIO[Env1 & Scope, Err, Out]
def url: URL

Concrete methods

final def @@[LowerEnv <: UpperEnv, UpperEnv <: Env, LowerIn <: UpperIn, UpperIn <: In, LowerErr >: Err, UpperErr >: LowerErr, LowerOut >: Out, UpperOut >: LowerOut](aspect: ZClientAspect[LowerEnv, UpperEnv, LowerIn, UpperIn, LowerErr, UpperErr, LowerOut, UpperOut]): ZClient[UpperEnv, UpperIn, LowerErr, LowerOut]

Applies the specified client aspect, which can modify the execution of this client.

Applies the specified client aspect, which can modify the execution of this client.

Attributes

final def contramap[In2](f: In2 => In): ZClient[Env, In2, Err, Out]
final def contramapZIO[Env1 <: Env, Err1 >: Err, In2](f: In2 => ZIO[Env1, Err1, In]): ZClient[Env1, In2, Err1, Out]
final def delete(pathSuffix: String, body: In)(implicit trace: Trace): ZIO[Env, Err, Out]
final def delete(pathSuffix: String)(implicit trace: Trace, ev: Body <:< In): ZIO[Env, Err, Out]
final def delete(implicit trace: Trace, ev: Body <:< In): ZIO[Env, Err, Out]
final def dieOn(f: Err => Boolean)(implicit ev1: IsSubtypeOfError[Err, Throwable], ev2: CanFail[Err], trace: Trace): ZClient[Env, In, Err, Out]
final def get(pathSuffix: String, body: In)(implicit trace: Trace): ZIO[Env, Err, Out]
final def get(pathSuffix: String)(implicit trace: Trace, ev: Body <:< In): ZIO[Env, Err, Out]
final def get(implicit trace: Trace, ev: Body <:< In): ZIO[Env, Err, Out]
final def head(pathSuffix: String, body: In)(implicit trace: Trace): ZIO[Env, Err, Out]
final def head(pathSuffix: String)(implicit trace: Trace, ev: Body <:< In): ZIO[Env, Err, Out]
final def head(implicit trace: Trace, ev: Body <:< In): ZIO[Env, Err, Out]
final def host(host: String): ZClient[Env, In, Err, Out]
final def map[Out2](f: Out => Out2): ZClient[Env, In, Err, Out2]
def mapError[Err2](f: Err => Err2): ZClient[Env, In, Err2, Out]
final def mapZIO[Env1 <: Env, Err1 >: Err, Out2](f: Out => ZIO[Env1, Err1, Out2]): ZClient[Env1, In, Err1, Out2]
final def patch(pathSuffix: String, body: In)(implicit trace: Trace): ZIO[Env, Err, Out]
final def path(segment: String): ZClient[Env, In, Err, Out]
final def port(port: Int): ZClient[Env, In, Err, Out]
final def post(pathSuffix: String, body: In)(implicit trace: Trace): ZIO[Env, Err, Out]
final def put(pathSuffix: String, body: In)(implicit trace: Trace): ZIO[Env, Err, Out]
def query(key: String, value: String): ZClient[Env, In, Err, Out]
final def refineOrDie[Err2](pf: PartialFunction[Err, Err2])(implicit ev1: IsSubtypeOfError[Err, Throwable], ev2: CanFail[Err], trace: Trace): ZClient[Env, In, Err2, Out]
final def request(method: Method, pathSuffix: String, body: In)(implicit trace: Trace): ZIO[Env, Err, Out]
final def request(request: Request)(implicit ev: Body <:< In, trace: Trace): ZIO[Env, Err, Out]
final def retry[Env1 <: Env](policy: Schedule[Env1, Err, Any]): ZClient[Env1, In, Err, Out]
final def scheme(scheme: Scheme): ZClient[Env, In, Err, Out]
final def socket[Env1 <: Env](pathSuffix: String)(app: SocketApp[Env1])(implicit trace: Trace): ZIO[Env1 & Scope, Err, Out]
final def ssl(ssl: ClientSSLConfig): ZClient[Env, In, Err, Out]
override def updateHeaders(update: Headers => Headers): ZClient[Env, In, Err, Out]

Updates the current Headers with new one, using the provided update function passed.

Updates the current Headers with new one, using the provided update function passed.

Attributes

Definition Classes
final def uri(uri: URI): ZClient[Env, In, Err, Out]
final def url(url: URL): ZClient[Env, In, Err, Out]
def withDisabledStreaming(implicit ev1: Out <:< Response, ev2: Err <:< Throwable): ZClient[Env, In, Throwable, Response]

Inherited methods

final def addHeader(name: CharSequence, value: CharSequence): A

Attributes

Inherited from:
HeaderModifier
final def addHeader(header: Header): A

Attributes

Inherited from:
HeaderModifier
final def addHeaders(headers: Headers): A

Attributes

Inherited from:
HeaderModifier
final def hasContentType(value: CharSequence): Boolean

Attributes

Inherited from:
HeaderChecks
final def hasFormUrlencodedContentType: Boolean

Attributes

Inherited from:
HeaderChecks
final def hasHeader(header: Header): Boolean

Attributes

Inherited from:
HeaderChecks
final def hasHeader(headerType: HeaderType): Boolean

Attributes

Inherited from:
HeaderChecks
final def hasHeader(name: CharSequence): Boolean

Attributes

Inherited from:
HeaderChecks
final def hasJsonContentType: Boolean

Attributes

Inherited from:
HeaderChecks
final def hasMediaType(mediaType: MediaType): Boolean

Attributes

Inherited from:
HeaderChecks
final def hasTextPlainContentType: Boolean

Attributes

Inherited from:
HeaderChecks
final def hasXhtmlXmlContentType: Boolean

Attributes

Inherited from:
HeaderChecks
final def hasXmlContentType: Boolean

Attributes

Inherited from:
HeaderChecks
final def header(headerType: HeaderType): Option[HeaderValue]

Gets a header or returns None if the header was not present or it could not be parsed

Gets a header or returns None if the header was not present or it could not be parsed

Attributes

Inherited from:
HeaderGetters
final def headerOrFail(headerType: HeaderType): Option[Either[String, HeaderValue]]

Gets a header. If the header is not present, returns None. If the header could not be parsed it returns the parsing error

Gets a header. If the header is not present, returns None. If the header could not be parsed it returns the parsing error

Attributes

Inherited from:
HeaderGetters
final def headers(headerType: HeaderType): Chunk[HeaderValue]

Attributes

Inherited from:
HeaderGetters
final def rawHeader(headerType: HeaderType): Option[String]

Gets the raw unparsed header value

Gets the raw unparsed header value

Attributes

Inherited from:
HeaderGetters
final def rawHeader(name: CharSequence): Option[String]

Gets the raw unparsed header value

Gets the raw unparsed header value

Attributes

Inherited from:
HeaderGetters
final def removeHeader(name: String): A

Attributes

Inherited from:
HeaderModifier
final def removeHeader(headerType: HeaderType): A

Attributes

Inherited from:
HeaderModifier
final def removeHeaders(headers: Set[String]): A

Attributes

Inherited from:
HeaderModifier
final def setHeaders(headers: Headers): A

Attributes

Inherited from:
HeaderModifier
def withHeader(header: Header): A

Attributes

Inherited from:
HeaderModifier
Generated with