sealed trait Route[-Env, +Err] extends AnyRef

Self Type
Route[Env, Err]
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Route
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def location: Trace

    The location where the route was created, which is useful for debugging purposes.

  2. abstract def routePattern: RoutePattern[_]

    The route pattern over which the route is defined.

    The route pattern over which the route is defined. The route can only handle requests that match this route pattern.

  3. abstract def toHandler(implicit ev: <:<[Err, Response], trace: Trace): Handler[Env, Response, Request, Response]

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def apply(request: Request)(implicit ev: <:<[Err, Response], trace: Trace): ZIO[Env, Response, Response]

    Applies the route to the specified request.

    Applies the route to the specified request. The route must be defined for the request, or else this method will fail fatally. Note that you may only call this function when you have handled all errors produced by the route, converting them into responses.

  5. def asErrorType[Err2](implicit ev: <:<[Err, Err2]): Route[Env, Err2]
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @IntrinsicCandidate()
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  11. final def handleError(f: (Err) ⇒ Response)(implicit trace: Trace): Route[Env, Nothing]

    Handles all typed errors in the route by converting them into responses.

    Handles all typed errors in the route by converting them into responses. This method can be used to convert a route that does not handle its errors into one that does handle its errors.

  12. final def handleErrorCause(f: (Cause[Err]) ⇒ Response)(implicit trace: Trace): Route[Env, Nothing]

    Handles all typed errors, as well as all non-recoverable errors, by converting them into responses.

    Handles all typed errors, as well as all non-recoverable errors, by converting them into responses. This method can be used to convert a route that does not handle its errors into one that does handle its errors.

  13. final def handleErrorCauseZIO(f: (Cause[Err]) ⇒ ZIO[Any, Nothing, Response])(implicit trace: Trace): Route[Env, Nothing]

    Handles all typed errors, as well as all non-recoverable errors, by converting them into a ZIO effect that produces the response.

    Handles all typed errors, as well as all non-recoverable errors, by converting them into a ZIO effect that produces the response. This method can be used to convert a route that does not handle its errors into one that does handle its errors.

  14. final def handleErrorRequest(f: (Err, Request) ⇒ Response)(implicit trace: Trace): Route[Env, Nothing]

    Handles all typed errors in the route by converting them into responses, taking into account the request that caused the error.

    Handles all typed errors in the route by converting them into responses, taking into account the request that caused the error. This method can be used to convert a route that does not handle its errors into one that does handle its errors.

  15. final def handleErrorRequestCause(f: (Request, Cause[Err]) ⇒ Response)(implicit trace: Trace): Route[Env, Nothing]

    Handles all typed errors, as well as all non-recoverable errors, by converting them into responses, taking into account the request that caused the error.

    Handles all typed errors, as well as all non-recoverable errors, by converting them into responses, taking into account the request that caused the error. This method can be used to convert a route that does not handle its errors into one that does handle its errors.

  16. final def handleErrorRequestCauseZIO(f: (Request, Cause[Err]) ⇒ ZIO[Any, Nothing, Response])(implicit trace: Trace): Route[Env, Nothing]

    Handles all typed errors, as well as all non-recoverable errors, by converting them into a ZIO effect that produces the response, taking into account the request that caused the error.

    Handles all typed errors, as well as all non-recoverable errors, by converting them into a ZIO effect that produces the response, taking into account the request that caused the error. This method can be used to convert a route that does not handle its errors into one that does handle its errors.

  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  18. final def isDefinedAt(request: Request): Boolean

    Determines if the route is defined for the specified request.

  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. final def mapError[Err1](fxn: (Err) ⇒ Err1)(implicit trace: Trace): Route[Env, Err1]

    Allows the transformation of the Err type through a function allowing one to build up a Routes in Stages targets the Unhandled case

  21. final def mapErrorZIO[Err1](fxn: (Err) ⇒ ZIO[Any, Err1, Response])(implicit trace: Trace): Route[Env, Err1]

    Allows the transformation of the Err type through an Effectful program allowing one to build up a Routes in Stages targets the Unhandled case only.

  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. def nest(prefix: PathCodec[Unit])(implicit ev: <:<[Err, Response]): Route[Env, Err]
  24. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  25. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  26. final def provideEnvironment(env: ZEnvironment[Env]): Route[Any, Err]
  27. final def run(request: Request)(implicit trace: Trace): ZIO[Env, Either[Err, Response], Response]

    Applies the route to the specified request.

    Applies the route to the specified request. The route must be defined for the request, or else this method will fail fatally.

  28. final def sandbox(implicit trace: Trace): Route[Env, Nothing]

    Returns a route that automatically translates all failures into responses, using best-effort heuristics to determine the appropriate HTTP status code, and attaching error details using the HTTP header Warning.

  29. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  30. final def toHttpApp(implicit ev: <:<[Err, Response]): HttpApp[Env]
  31. def toString(): String
    Definition Classes
    AnyRef → Any
  32. def transform[Env1](f: (Handler[Env, Response, Request, Response]) ⇒ Handler[Env1, Response, Request, Response]): Route[Env1, Err]
  33. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  35. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped