ZIO Laminar Tapir
3.1.0+2-757cd874-SNAPSHOT
DocsAPI
Generated with
Copyright (c) 2022-2025, Olivier NOUGUIER
Copyright (c) 2022-2025, Olivier NOUGUIER
ZIO Laminar Tapir/dev.cheleb/dev.cheleb.ziotapir

dev.cheleb.ziotapir

package dev.cheleb.ziotapir

Members list

Packages

package dev.cheleb.ziotapir.laminar

Type members

Classlikes

trait BackendClient

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
object BackendClientLive

The live implementation of the BackendClient.

The live implementation of the BackendClient.

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
trait BaseController

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
trait Session[+UserToken <: WithToken]

A session management interface for Laminar applications.

A session management interface for Laminar applications.

Type parameters

UserToken

The type of the user token, which should extend dev.cheleb.ziojwt.WithToken.

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class SessionLive[UserToken]
class SessionLive[UserToken <: WithToken](using x$1: JsonDecoder[UserToken]) extends Session[UserToken]

Attributes

Supertypes
trait Session[UserToken]
class Object
trait Matchable
class Any
object Storage

Attributes

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

Extensions

Extensions

extension [I, E <: Throwable, O](endpoint: Endpoint[Unit, I, E, O, Any])
def apply(payload: I): RIO[BackendClient, O]

Call the endpoint with a payload, and get a ZIO back.

Call the endpoint with a payload, and get a ZIO back.

Attributes

extension [I, E <: Throwable, O](endpoint: Endpoint[String, I, E, O, Any])
def apply[UserToken <: WithToken](payload: I)(using session: Session[UserToken]): RIO[BackendClient, O]

Call the secured endpoint with a payload, and get a ZIO back.

Call the secured endpoint with a payload, and get a ZIO back.

Attributes

extension [I, O](endpoint: Endpoint[Unit, I, Throwable, Stream[Throwable, O], ZioStreams])
def apply(payload: I): RIO[BackendClient, Stream[Throwable, O]]

Call the endpoint with a payload, and get a ZIO back.

Call the endpoint with a payload, and get a ZIO back.

Attributes

extension [I, O](endpoint: Endpoint[String, I, Throwable, Stream[Throwable, O], ZioStreams])
def apply[UserToken <: WithToken](payload: I)(using session: Session[UserToken]): RIO[BackendClient, Stream[Throwable, O]]

Call the secured stream endpoint with a payload, and get a ZIO back.

Call the secured stream endpoint with a payload, and get a ZIO back.

Attributes

extension (hub: Hub[WebSocketFrame])
def closeGracefully: UIO[Unit]

Closes the WebSocket connection gracefully by sending a Close frame and shutting down the hub.

Closes the WebSocket connection gracefully by sending a Close frame and shutting down the hub.

Attributes

Returns

A UIO[Unit] that completes when the close operation is done.

def sendText(message: String): UIO[Boolean]

Sends a text message over the WebSocket.

Sends a text message over the WebSocket.

Attributes

Returns

A UIO[Boolean] indicating whether the message was successfully published.

extension [I, E, WI, WO](wse: Endpoint[Unit, I, E, Stream[Throwable, WI] => Stream[Throwable, WO], ZioStreams & WebSockets])
def apply(payload: I): RIO[BackendClient, Stream[Throwable, WI] => Stream[Throwable, WO]]
def responseZIO(payload: I): RIO[BackendClient, Response[Stream[Throwable, WI] => Stream[Throwable, WO]]]

Call the WebSocket endpoint with a payload, and get a ZIO back.

Call the WebSocket endpoint with a payload, and get a ZIO back.

Attributes

extension [E <: Throwable, A](zio: ZIO[Any, E, A])
def runSyncUnsafe(): A

Extension to ZIO[Any, E, A] that allows us to run in JS.

Extension to ZIO[Any, E, A] that allows us to run in JS.

Value parameters

zio

the ZIO to run

Attributes

Generated with
Copyright (c) 2022-2025, Olivier NOUGUIER
Copyright (c) 2022-2025, Olivier NOUGUIER