iw-support-tapir
API
Generated with
iw-support-tapir/works.iterative.tapir

works.iterative.tapir

package works.iterative.tapir

Members list

Packages

package works.iterative.tapir.codecs
package works.iterative.tapir.endpoints

Type members

Classlikes

trait ApiClientFactory

Create effectful methods to perform the endpoint operation.

Create effectful methods to perform the endpoint operation.

The factory takes an endpoint with correct type signature, and returns a function that can call the endpoint.

The resulting error channel is whatever the endpoint declares as the client error channel, eg. the type E of ApiError[E], which is what is reported in RequestFailure[E].

The other options - AuthenticationFailure, ServerFailure - are converted to defects to be handled at another level.

This way the client can deal only with what it can actually do something about.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object ApiClientFactory

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
sealed trait ApiError[+ClientError]

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class AuthFailure
class RequestFailure[ClientError]
object ApiError

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
ApiError.type
final case class ApiKeyConfig(apiKeys: Map[String, String])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ApiKeyConfig

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
trait ApiKeyGuard

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object ApiKeyGuard

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
class AuthenticatedApiClientFactory(authentication: AuthenticationService, clientFactory: ClientEndpointFactory) extends ApiClientFactory

Attributes

Supertypes
class Object
trait Matchable
class Any
case class BaseUri(value: Option[Uri])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object BaseUri extends BaseUriPlatformSpecific

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
BaseUri.type
trait BaseUriExtractor[-O]

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object BaseUriExtractor extends LowPriorityBaseUriImplicits

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
trait BaseUriPlatformSpecific

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object BaseUri
trait ClientEndpointFactory

Create effectful methods to perform the endpoint operation

Create effectful methods to perform the endpoint operation

Just a useful way to have something that will derive the client from the endpoint using other layers, like BaseUri and provided STTP Backend.

The resulting type is either

  • S => I => IO[E, O] if the endpoint is secure and error prone
  • S => I => UIO[O] if the endpoint is secure and infallible
  • I => IO[E, O] if the endpoint is public and error prone
  • I => UIO[O] if the endpoint is public and infallible

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait ClientErrorConstructor[-E]

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object ClientErrorConstructor extends LowPriorityClientErrorConstructorImplicits

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
trait ClientResultConstructor[S, I, E, O]

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object ClientResultConstructor extends LowProirityClientResultConstructorImplicits

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
trait CustomTapir extends Tapir, TapirJsonZio, TapirAliases, CustomTapirPlatformSpecific

Attributes

Companion
object
Supertypes
trait SttpClientInterpreter
trait SttpClientInterpreterExtensions
trait TapirAliases
trait TapirJsonZio
trait Tapir
trait ModifyMacroSupport
trait ModifyMacroFunctorSupport
trait TapirStaticContentEndpoints
trait TapirComputedInputs
trait TapirExtensions
class Object
trait Matchable
class Any
Show all
Known subtypes
trait RepositoryEndpointsModule[K, V, F]
object CustomTapir
object CustomTapir extends CustomTapir

Attributes

Companion
trait
Supertypes
trait CustomTapir
trait SttpClientInterpreter
trait SttpClientInterpreterExtensions
trait TapirAliases
trait TapirJsonZio
trait Tapir
trait ModifyMacroSupport
trait ModifyMacroFunctorSupport
trait TapirStaticContentEndpoints
trait TapirComputedInputs
trait TapirExtensions
class Object
trait Matchable
class Any
Show all
Self type
trait CustomTapirPlatformSpecific extends SttpClientInterpreter

Attributes

Supertypes
trait SttpClientInterpreter
trait SttpClientInterpreterExtensions
class Object
trait Matchable
class Any
Known subtypes
trait CustomTapir
trait RepositoryEndpointsModule[K, V, F]
object CustomTapir
Self type
class LiveApiKeyGuard(config: ApiKeyConfig) extends ApiKeyGuard

Attributes

Companion
object
Supertypes
trait ApiKeyGuard
class Object
trait Matchable
class Any
object LiveApiKeyGuard

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
class LiveClientEndpointFactory(using baseUri: BaseUri, backend: Backend) extends ClientEndpointFactory, CustomTapir

Attributes

Companion
object
Supertypes
trait CustomTapir
trait SttpClientInterpreter
trait SttpClientInterpreterExtensions
trait TapirAliases
trait TapirJsonZio
trait Tapir
trait ModifyMacroSupport
trait ModifyMacroFunctorSupport
trait TapirStaticContentEndpoints
trait TapirComputedInputs
trait TapirExtensions
class Object
trait Matchable
class Any
Show all
object LiveClientEndpointFactory

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
trait LowPriorityBaseUriImplicits

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait LowPriorityClientErrorConstructorImplicits

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait LowProirityClientResultConstructorImplicits

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class ReconectingUpdateSource[A](updateHub: Hub[A], retrySchedule: Schedule[Any, Any, _] = ...)

Run a read-only source from server, publish whatever comes to a hub. Reconnect on failure.

Run a read-only source from server, publish whatever comes to a hub. Reconnect on failure.

Type parameters

A

type of updates

Value parameters

retrySchedule

schedule for retries, defaults to 2 seconds

updateHub

hub to publish updates to

Attributes

Supertypes
class Object
trait Matchable
class Any

Types

type ApiEndpoint[E, I, O] = Endpoint[AccessToken, I, ApiError[E], O, ZioStreams]
Generated with