class SttpBackendStub[F[_], S, WS_HANDLER[_]] extends SttpBackend[F, S, WS_HANDLER]
A stub backend to use in tests.
The stub can be configured to respond with a given response if the request matches a predicate (see the whenRequestMatches() method).
Note however, that this is not type-safe with respect to the type of the
response body - the stub doesn't have a way to check if the type of the
body in the configured response is the same as the one specified by the
request. Some conversions will be attempted (e.g. from a String to
a custom mapped type, as specified in the request, see the documentation
for more details).
Hence, the predicates can match requests basing on the URI or headers. A ClassCastException might occur if for a given request, a response is specified with the incorrect or inconvertible body type.
- Alphabetic
- By Inheritance
- SttpBackendStub
- SttpBackend
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new SttpBackendStub(monad: MonadError[F], matchers: PartialFunction[Request[_, _], F[Response[_]]], wsMatchers: PartialFunction[Request[_, _], WhenOpenWebsocket[F, WS_HANDLER]], fallback: Option[SttpBackend[F, S, WS_HANDLER]])
Type Members
- class WhenRequest extends AnyRef
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native() @HotSpotIntrinsicCandidate()
-
def
close(): F[Unit]
- Definition Classes
- SttpBackendStub → SttpBackend
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
openWebsocket[T, WR](request: Request[T, S], handler: WS_HANDLER[WR]): F[WebSocketResponse[WR]]
Opens a websocket, using the given backend-specific handler.
Opens a websocket, using the given backend-specific handler.
If the connection doesn't result in a websocket being opened, a failed effect is returned, or an exception is thrown (depending on
F).- Definition Classes
- SttpBackendStub → SttpBackend
-
def
responseMonad: MonadError[F]
The effect wrapper for responses.
The effect wrapper for responses. Allows writing wrapper backends, which map/flatMap over the return value of send and openWebsocket.
- Definition Classes
- SttpBackendStub → SttpBackend
-
def
send[T](request: Request[T, S]): F[Response[T]]
- Definition Classes
- SttpBackendStub → SttpBackend
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
def
whenAnyRequest: WhenRequest
Specify how the stub backend should respond to any request (catch-all).
Specify how the stub backend should respond to any request (catch-all).
Note that the stubs are immutable, and each new specification that is added yields a new stub instance.
-
def
whenRequestMatches(p: (Request[_, _]) ⇒ Boolean): WhenRequest
Specify how the stub backend should respond to requests matching the given predicate.
Specify how the stub backend should respond to requests matching the given predicate.
Note that the stubs are immutable, and each new specification that is added yields a new stub instance.
-
def
whenRequestMatchesPartial(partial: PartialFunction[Request[_, _], Response[_]]): SttpBackendStub[F, S, WS_HANDLER]
Specify how the stub backend should respond to requests using the given partial function.
Specify how the stub backend should respond to requests using the given partial function.
Note that the stubs are immutable, and each new specification that is added yields a new stub instance.
-
def
whenRequestMatchesPartialHandleOpenWebsocket[WS_RESULT](partial: PartialFunction[Request[_, _], (Headers, (WS_HANDLER[WS_RESULT]) ⇒ WS_RESULT)]): SttpBackendStub[F, S, WS_HANDLER]
Specify how the stub backend should use web socket handler using the given partial function.
Specify how the stub backend should use web socket handler using the given partial function. Meant mainly for akka backend or cases when implementing a custom WS_HANDLER.
-
def
whenRequestMatchesPartialReturnWebSocketResponse[WS_RESULT](partial: PartialFunction[Request[_, _], (Headers, WS_RESULT)]): SttpBackendStub[F, S, WS_HANDLER]
Specify how the stub backend should respond to open websocket requests using the given partial function.