SttpBackendStub

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.

Linear Supertypes

SttpBackend[R, S], AnyRef, Any

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[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def close(): R[Unit]

Definition Classes
SttpBackendStub → SttpBackend
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def responseMonad: MonadError[R]

The monad in which the responses are wrapped.
The monad in which the responses are wrapped. Allows writing wrapper backends, which map/flatMap over the return value of send.

Definition Classes
SttpBackendStub → SttpBackend
def send[T](request: Request[T, S]): R[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(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): 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[R, S]

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.

Related Docs: object SttpBackendStub | package testing

class SttpBackendStub[R[_], S] extends SttpBackend[R, S]

Type Members

class WhenRequest extends AnyRef

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def close(): R[Unit]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def responseMonad: MonadError[R]

def send[T](request: Request[T, S]): R[Response[T]]

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def whenAnyRequest: WhenRequest

def whenRequestMatches(p: (Request[_, _]) ⇒ Boolean): WhenRequest

def whenRequestMatchesPartial(partial: PartialFunction[Request[_, _], Response[_]]): SttpBackendStub[R, S]

Inherited from SttpBackend[R, S]

Inherited from AnyRef

Inherited from Any

Ungrouped