Skip to content
scalive
Menu
ConnectingLiveReconnectingOffline
c

LiveRouteBuilder

class LiveRouteBuilder[A]

Common operations for an ordinary (non-routed) LiveView route.

Defined by scalive.LiveRouteBuilder. View source (scalive/api/src/scalive/routing/LiveRouting.scala:196-374)

Methods14

->

def ->: [Msg, Model](view: => LiveView[Msg, Model])(LiveRoute[Any, A] { type Input = Any })

Defined by scalive.LiveRouteBuilder.->. View source (scalive/api/src/scalive/routing/LiveRouting.scala:345-347)

/

def /[B](that: zio.http.codec.PathCodec[B])(using combiner: zio.http.codec.Combiner[A, B]): LiveRouteSeed[combiner.Out]

Defined by scalive.LiveRouteBuilder./. View source (scalive/api/src/scalive/routing/LiveRouting.scala:201-202)

apply

def apply: [Ctx, Msg, Model](factory: (A, zio.http.Request, Ctx) => LiveView[Msg, Model])(LiveRoute[Any, A] { type Input = Ctx })

Defined by scalive.LiveRouteBuilder.apply. View source (scalive/api/src/scalive/routing/LiveRouting.scala:301-313)

def apply: [Msg, Model](factory: zio.http.Request => LiveView[Msg, Model])(LiveRoute[Any, A] { type Input = Any })

Defined by scalive.LiveRouteBuilder.apply. View source (scalive/api/src/scalive/routing/LiveRouting.scala:296-299)

def apply: [Msg, Model](view: => LiveView[Msg, Model])(LiveRoute[Any, A] { type Input = Any })

Defined by scalive.LiveRouteBuilder.apply. View source (scalive/api/src/scalive/routing/LiveRouting.scala:293-294)

context

def context: [Ctx, Msg, Model](factory: Ctx => LiveView[Msg, Model])(LiveRoute[Any, A] { type Input = Ctx })

Defined by scalive.LiveRouteBuilder.context. View source (scalive/api/src/scalive/routing/LiveRouting.scala:315-318)

def context: [Ctx, Msg, Model](factory: (A, zio.http.Request, Ctx) => LiveView[Msg, Model])(LiveRoute[Any, A] { type Input = Ctx })

Defined by scalive.LiveRouteBuilder.context. View source (scalive/api/src/scalive/routing/LiveRouting.scala:325-328)

def context: [Ctx, R, Msg, Model](factory: (Ctx, R) => LiveView[Msg, Model])(using evidence$1: zio.package.Tag[R])(LiveRoute[R, A] { type Input = Ctx })

Defined by scalive.LiveRouteBuilder.context. View source (scalive/api/src/scalive/routing/LiveRouting.scala:320-323)

def context: [Ctx, R, Msg, Model](factory: (A, zio.http.Request, Ctx, R) => LiveView[Msg, Model])(using evidence$1: zio.package.Tag[R])(LiveRoute[R, A] { type Input = Ctx })

Defined by scalive.LiveRouteBuilder.context. View source (scalive/api/src/scalive/routing/LiveRouting.scala:330-343)

from

def from: [R, Msg, Model](factory: (A, zio.http.Request, R) => LiveView[Msg, Model])(using evidence$1: zio.package.Tag[R])(LiveRoute[R, A] { type Input = Any })

Defined by scalive.LiveRouteBuilder.from. View source (scalive/api/src/scalive/routing/LiveRouting.scala:349-360)

location

def location(using ev: =:=[A, Unit]): LiveLocation

Defined by scalive.LiveRouteBuilder.location. View source (scalive/api/src/scalive/routing/LiveRouting.scala:210-211)

def location(value: A): LiveLocation

Defined by scalive.LiveRouteBuilder.location. View source (scalive/api/src/scalive/routing/LiveRouting.scala:204-205)

locationEither

def locationEither(using ev: =:=[A, Unit]): Either[LiveLocation.EncodeError, LiveLocation]

Defined by scalive.LiveRouteBuilder.locationEither. View source (scalive/api/src/scalive/routing/LiveRouting.scala:213-215)

def locationEither(value: A): Either[LiveLocation.EncodeError, LiveLocation]

Defined by scalive.LiveRouteBuilder.locationEither. View source (scalive/api/src/scalive/routing/LiveRouting.scala:207-208)

params

def params[Params](codec: LiveParamsCodec[A, Params]): LiveEncodableRouteParamsBuilder[A, Params]

Defined by scalive.LiveRouteBuilder.params. View source (scalive/api/src/scalive/routing/LiveRouting.scala:257-260)

def params: LiveEncodableRouteParamsBuilder[A, A]

Defined by scalive.LiveRouteBuilder.params. View source (scalive/api/src/scalive/routing/LiveRouting.scala:249-255)

paramsDecodeOnly

def paramsDecodeOnly[Params](decoder: LiveParamsDecoder[A, Params]): LiveRouteParamsBuilder[A, Params]

Defined by scalive.LiveRouteBuilder.paramsDecodeOnly. View source (scalive/api/src/scalive/routing/LiveRouting.scala:262-265)

query

def query[Query](codec: zio.http.codec.package.QueryCodec[Query])(using combiner: zio.http.codec.Combiner[A, Query]): LiveEncodableRouteParamsBuilder[A, combiner.Out]

Defined by scalive.LiveRouteBuilder.query. View source (scalive/api/src/scalive/routing/LiveRouting.scala:217-227)

def query[Query](name: String)(using evidence$1: zio.schema.Schema[Query], combiner: zio.http.codec.Combiner[A, Query]): LiveEncodableRouteParamsBuilder[A, combiner.Out]

Defined by scalive.LiveRouteBuilder.query. View source (scalive/api/src/scalive/routing/LiveRouting.scala:229-234)

def query[Query](using evidence$1: zio.schema.Schema[Query], combiner: zio.http.codec.Combiner[A, Query]): LiveEncodableRouteParamsBuilder[A, combiner.Out]

Defined by scalive.LiveRouteBuilder.query. View source (scalive/api/src/scalive/routing/LiveRouting.scala:243-247)

queryOptional

def queryOptional[Query](name: String)(using evidence$1: zio.schema.Schema[Query], combiner: zio.http.codec.Combiner[A, Option[Query]]): LiveEncodableRouteParamsBuilder[A, combiner.Out]

Defined by scalive.LiveRouteBuilder.queryOptional. View source (scalive/api/src/scalive/routing/LiveRouting.scala:236-241)

withLayout

def withLayout(layout: LiveLayout[A, Any]): LiveRouteBuilder[A]

Defined by scalive.LiveRouteBuilder.withLayout. View source (scalive/api/src/scalive/routing/LiveRouting.scala:267-272)

withMountAspect

def withMountAspect[R, In, Claims, Out, Result](aspect: LiveMountAspect[R, A, In, Claims, Out])(using append: ContextAppend.Aux[In, Out, Result]): LiveRouteMountAspectBuilder[R, A, In, Result]

Starts a typed route mount pipeline. The resulting context is supplied to route factories.

Defined by scalive.LiveRouteBuilder.withMountAspect. View source (scalive/api/src/scalive/routing/LiveRouting.scala:282-291)

withRootLayout

def withRootLayout(layout: LiveRootLayout[A, Any]): LiveRouteBuilder[A]

Defined by scalive.LiveRouteBuilder.withRootLayout. View source (scalive/api/src/scalive/routing/LiveRouting.scala:274-279)