sttp
client3
package
client3
Linear Supertypes
SttpApi
,
UriInterpolator
,
SttpExtensions
,
AnyRef
,
Any
Ordering
Alphabetic
By Inheritance
Inherited
client3
SttpApi
UriInterpolator
SttpExtensions
AnyRef
Any
Hide All
Show All
Visibility
Public
All
Type Members
type
BodySerializer
[
B
]
= (
B
) ⇒
BasicRequestBody
type
Empty
[
X
]
=
None
.type
type
Identity
[
X
]
=
X
type
PartialRequest
[
T
,
-R
]
=
RequestT
[
Empty
,
T
,
R
]
type
Request
[
T
,
-R
]
=
RequestT
[
Identity
,
T
,
R
]
type
RetryWhen
= (
Request
[_, _],
Either
[
Throwable
,
Response
[_]]) ⇒
Boolean
implicit
class
UriContext
extends
AnyRef
Definition Classes
UriInterpolator
type
DeserializationError
[
DE
]
=
DeserializationException
[
DE
]
Annotations
@deprecated
Deprecated
(Since version 3.0.0)
use DeserializationException
type
ResponseError
[
+HE
,
+DE
]
=
ResponseException
[
HE
,
DE
]
Annotations
@deprecated
Deprecated
(Since version 3.0.0)
use ResponseException
Value Members
val
DefaultReadTimeout
:
Duration
Definition Classes
SttpApi
def
asBoth
[
A
,
B
]
(
l:
ResponseAs
[
A
,
Any
]
,
r:
ResponseAs
[
B
,
Any
]
)
:
ResponseAs
[(
A
,
B
),
Any
]
Definition Classes
SttpApi
def
asBothOption
[
A
,
B
,
R
]
(
l:
ResponseAs
[
A
,
R
]
,
r:
ResponseAs
[
B
,
Any
]
)
:
ResponseAs
[(
A
,
Option
[
B
]),
R
]
Definition Classes
SttpApi
def
asByteArray
:
ResponseAs
[
Either
[
String
,
Array
[
Byte
]],
Any
]
Definition Classes
SttpApi
def
asByteArrayAlways
:
ResponseAs
[
Array
[
Byte
],
Any
]
Definition Classes
SttpApi
def
asEither
[
A
,
B
,
R
]
(
onError:
ResponseAs
[
A
,
R
]
,
onSuccess:
ResponseAs
[
B
,
R
]
)
:
ResponseAs
[
Either
[
A
,
B
],
R
]
Definition Classes
SttpApi
def
asFile
(
file:
File
)
:
ResponseAs
[
Either
[
String
,
File
],
Any
]
Definition Classes
SttpExtensions
def
asFileAlways
(
file:
File
)
:
ResponseAs
[
File
,
Any
]
Definition Classes
SttpExtensions
def
asParams
(
charset:
String
)
:
ResponseAs
[
Either
[
String
,
Seq
[(
String
,
String
)]],
Any
]
Definition Classes
SttpApi
def
asParams
:
ResponseAs
[
Either
[
String
,
Seq
[(
String
,
String
)]],
Any
]
Definition Classes
SttpApi
def
asParamsAlways
(
charset:
String
)
:
ResponseAs
[
Seq
[(
String
,
String
)],
Any
]
Definition Classes
SttpApi
def
asParamsAlways
:
ResponseAs
[
Seq
[(
String
,
String
)],
Any
]
Definition Classes
SttpApi
def
asPath
(
path:
Path
)
:
ResponseAs
[
Either
[
String
,
Path
],
Any
]
Definition Classes
SttpExtensions
def
asPathAlways
(
path:
Path
)
:
ResponseAs
[
Path
,
Any
]
Definition Classes
SttpExtensions
def
asStream
[
F
[
_
]
,
T
,
S
]
(
s:
Streams
[
S
]
)
(
f: (
BinaryStream
) ⇒
F
[
T
]
)
:
ResponseAs
[
Either
[
String
,
T
],
Effect
[
F
] with
S
]
Definition Classes
SttpApi
def
asStreamAlways
[
F
[
_
]
,
T
,
S
]
(
s:
Streams
[
S
]
)
(
f: (
BinaryStream
) ⇒
F
[
T
]
)
:
ResponseAs
[
T
,
Effect
[
F
] with
S
]
Definition Classes
SttpApi
def
asStreamAlwaysUnsafe
[
S
]
(
s:
Streams
[
S
]
)
:
ResponseAs
[
BinaryStream
,
S
]
Definition Classes
SttpApi
def
asStreamAlwaysWithMetadata
[
F
[
_
]
,
T
,
S
]
(
s:
Streams
[
S
]
)
(
f: (
BinaryStream
,
ResponseMetadata
) ⇒
F
[
T
]
)
:
ResponseAs
[
T
,
Effect
[
F
] with
S
]
Definition Classes
SttpApi
def
asStreamUnsafe
[
S
]
(
s:
Streams
[
S
]
)
:
ResponseAs
[
Either
[
String
,
BinaryStream
],
S
]
Definition Classes
SttpApi
def
asStreamWithMetadata
[
F
[
_
]
,
T
,
S
]
(
s:
Streams
[
S
]
)
(
f: (
BinaryStream
,
ResponseMetadata
) ⇒
F
[
T
]
)
:
ResponseAs
[
Either
[
String
,
T
],
Effect
[
F
] with
S
]
Definition Classes
SttpApi
def
asString
(
charset:
String
)
:
ResponseAs
[
Either
[
String
,
String
],
Any
]
Definition Classes
SttpApi
def
asString
:
ResponseAs
[
Either
[
String
,
String
],
Any
]
Definition Classes
SttpApi
def
asStringAlways
(
charset:
String
)
:
ResponseAs
[
String
,
Any
]
Definition Classes
SttpApi
def
asStringAlways
:
ResponseAs
[
String
,
Any
]
Definition Classes
SttpApi
def
asWebSocket
[
F
[
_
]
,
T
]
(
f: (
WebSocket
[
F
]) ⇒
F
[
T
]
)
:
ResponseAs
[
Either
[
String
,
T
],
Effect
[
F
] with
WebSockets
]
Definition Classes
SttpApi
def
asWebSocketAlways
[
F
[
_
]
,
T
]
(
f: (
WebSocket
[
F
]) ⇒
F
[
T
]
)
:
ResponseAs
[
T
,
Effect
[
F
] with
WebSockets
]
Definition Classes
SttpApi
def
asWebSocketAlwaysUnsafe
[
F
[
_
]
]
:
ResponseAs
[
WebSocket
[
F
],
Effect
[
F
] with
WebSockets
]
Definition Classes
SttpApi
def
asWebSocketAlwaysWithMetadata
[
F
[
_
]
,
T
]
(
f: (
WebSocket
[
F
],
ResponseMetadata
) ⇒
F
[
T
]
)
:
ResponseAs
[
T
,
Effect
[
F
] with
WebSockets
]
Definition Classes
SttpApi
def
asWebSocketEither
[
A
,
B
,
R
]
(
onError:
ResponseAs
[
A
,
R
]
,
onSuccess:
ResponseAs
[
B
,
R
]
)
:
ResponseAs
[
Either
[
A
,
B
],
R
]
Definition Classes
SttpApi
def
asWebSocketStream
[
S
]
(
s:
Streams
[
S
]
)
(
p:
Pipe
[
Data
[_],
WebSocketFrame
]
)
:
ResponseAs
[
Either
[
String
,
Unit
],
S
with
WebSockets
]
Definition Classes
SttpApi
def
asWebSocketStreamAlways
[
S
]
(
s:
Streams
[
S
]
)
(
p:
Pipe
[
Data
[_],
WebSocketFrame
]
)
:
ResponseAs
[
Unit
,
S
with
WebSockets
]
Definition Classes
SttpApi
def
asWebSocketUnsafe
[
F
[
_
]
]
:
ResponseAs
[
Either
[
String
,
WebSocket
[
F
]],
Effect
[
F
] with
WebSockets
]
Definition Classes
SttpApi
def
asWebSocketWithMetadata
[
F
[
_
]
,
T
]
(
f: (
WebSocket
[
F
],
ResponseMetadata
) ⇒
F
[
T
]
)
:
ResponseAs
[
Either
[
String
,
T
],
Effect
[
F
] with
WebSockets
]
Definition Classes
SttpApi
val
basicRequest
:
RequestT
[
Empty
,
Either
[
String
,
String
],
Any
]
Definition Classes
SttpApi
package
circe
val
emptyRequest
:
RequestT
[
Empty
,
Either
[
String
,
String
],
Any
]
Definition Classes
SttpApi
def
fromMetadata
[
T
,
R
]
(
default:
ResponseAs
[
T
,
R
]
,
conditions:
ConditionalResponseAs
[
T
,
R
]*
)
:
ResponseAs
[
T
,
R
]
Definition Classes
SttpApi
def
ignore
:
ResponseAs
[
Unit
,
Any
]
Definition Classes
SttpApi
def
multipart
[
B
]
(
name:
String
,
b:
B
)
(
implicit
arg0:
BodySerializer
[
B
]
)
:
Part
[
BasicRequestBody
]
Definition Classes
SttpApi
def
multipart
(
name:
String
,
fs:
Seq
[(
String
,
String
)]
,
encoding:
String
)
:
Part
[
BasicRequestBody
]
Definition Classes
SttpApi
def
multipart
(
name:
String
,
fs:
Seq
[(
String
,
String
)]
)
:
Part
[
BasicRequestBody
]
Definition Classes
SttpApi
def
multipart
(
name:
String
,
fs:
Map
[
String
,
String
]
,
encoding:
String
)
:
Part
[
BasicRequestBody
]
Definition Classes
SttpApi
def
multipart
(
name:
String
,
fs:
Map
[
String
,
String
]
)
:
Part
[
BasicRequestBody
]
Definition Classes
SttpApi
def
multipart
(
name:
String
,
data:
InputStream
)
:
Part
[
BasicRequestBody
]
Definition Classes
SttpApi
def
multipart
(
name:
String
,
data:
ByteBuffer
)
:
Part
[
BasicRequestBody
]
Definition Classes
SttpApi
def
multipart
(
name:
String
,
data:
Array
[
Byte
]
)
:
Part
[
BasicRequestBody
]
Definition Classes
SttpApi
def
multipart
(
name:
String
,
data:
String
,
encoding:
String
)
:
Part
[
BasicRequestBody
]
Definition Classes
SttpApi
def
multipart
(
name:
String
,
data:
String
)
:
Part
[
BasicRequestBody
]
Definition Classes
SttpApi
def
multipartFile
(
name:
String
,
data:
Path
)
:
Part
[
RequestBody
[
Any
]]
Definition Classes
SttpExtensions
def
multipartFile
(
name:
String
,
data:
File
)
:
Part
[
RequestBody
[
Any
]]
Definition Classes
SttpExtensions
def
multipartStream
[
S
]
(
s:
Streams
[
S
]
)
(
name:
String
,
b:
BinaryStream
)
:
Part
[
RequestBody
[
S
]]
Definition Classes
SttpApi
val
quickRequest
:
RequestT
[
Empty
,
String
,
Any
]
Definition Classes
SttpApi
Inherited from
SttpApi
Inherited from
UriInterpolator
Inherited from
SttpExtensions
Inherited from
AnyRef
Inherited from
Any
Ungrouped