dev.cheleb.ziotapir

Members list

Packages

Type members

Classlikes

A client to the backend, extending the endpoints as methods.

A client to the backend, extending the endpoints as methods.

Attributes

Supertypes
class Object
trait Matchable
class Any
final case class BackendClientConfig(baseUrl: Uri)

Configuration for the backend client.

Configuration for the backend client.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

The live implementation of the BackendClient.

The live implementation of the BackendClient.

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait SecuredBaseController[SI, Principal]
final case class HttpError(statusCode: StatusCode, message: String, cause: Throwable) extends RuntimeException

Represents an HTTP error with a status code, message, and cause.

Represents an HTTP error with a status code, message, and cause.

Attributes

Companion
object
Supertypes
trait Product
trait Equals
class RuntimeException
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
object HttpError

Provides methods to decode and encode HttpError instances.

Provides methods to decode and encode HttpError instances.

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
HttpError.type
case class RestrictedEndpointException(message: String) extends RuntimeException

Typed exception for restricted endpoints.

Typed exception for restricted endpoints.

Attributes

Supertypes
trait Product
trait Equals
class RuntimeException
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
trait Routes

A trait that provides a method to gather all the routes from a controllers.

A trait that provides a method to gather all the routes from a controllers.

The method gatherRoutes takes a function that selects the routes from a controller, the type parameter C is the type of the context that the routes require (Streams, WebSockets, etc.).

Type parameters

C

The type of the context that the routes require.

Attributes

Supertypes
class Object
trait Matchable
class Any
trait SecuredBaseController[SI, Principal](principalExtractor: SI => Task[Principal]) extends BaseController

A base controller for all secured endpoints

A base controller for all secured endpoints

Value parameters

principalExtractor

the function to extract the principal from the Security Input

Attributes

Supertypes
class Object
trait Matchable
class Any
object Storage

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
Storage.type