t

cask.router

Endpoint

trait Endpoint[InnerReturned, Input] extends Decorator[InnerReturned, Input]

An HttpEndpoint that may return something else than a HTTP response, e.g. a websocket endpoint which may instead return a websocket event handler

Linear Supertypes
Decorator[InnerReturned, Input], AnyRef, Any
Known Subclasses
WebEndpoint, get, getJson, post, postForm, postJson, put, route, staticFiles, staticResources, websocket, HttpEndpoint
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Endpoint
  2. Decorator
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. final type Delegate = (Map[String, Input]) ⇒ Result[InnerReturned]
    Definition Classes
    Decorator
  2. abstract type InputParser[T] <: ArgReader[Input, T, model.Request]
    Definition Classes
    Decorator
  3. final type InputTypeAlias = Input
    Definition Classes
    Decorator
  4. abstract type OuterReturned <: Result[Any]
    Definition Classes
    Decorator

Abstract Value Members

  1. abstract val methods: Seq[String]

    Which HTTP methods does this endpoint support? POST? GET? PUT? Or some combination of those?

  2. abstract val path: String

    What is the path that this particular endpoint matches?

  3. abstract def wrapFunction(ctx: model.Request, delegate: Delegate): OuterReturned
    Definition Classes
    Decorator
  4. abstract def wrapPathSegment(s: String): Input

    HttpEndpoints are unique among decorators in that they alone can bind path segments to parameters, e.g.

    HttpEndpoints are unique among decorators in that they alone can bind path segments to parameters, e.g. binding /hello/:world to (world: Int). In order to do so, we need to box up the path segment strings into an Input so they can later be parsed by getParamParser into an instance of the appropriate type.

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 asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  6. def convertToResultType[T](t: T)(implicit f: Conversion[T, InnerReturned]): InnerReturned
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  10. def getParamParser[T](implicit p: InputParser[T]): InputParser[T]
    Definition Classes
    Decorator
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. def subpath: Boolean

    Whether or not this endpoint allows matching on sub-paths: does @endpoint("/foo") capture the path "/foo/bar/baz"? Useful to e.g.

    Whether or not this endpoint allows matching on sub-paths: does @endpoint("/foo") capture the path "/foo/bar/baz"? Useful to e.g. have an endpoint match URLs with paths in a filesystem (real or virtual) to serve files

  17. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  18. def toString(): String
    Definition Classes
    AnyRef → Any
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  21. 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
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from Decorator[InnerReturned, Input]

Inherited from AnyRef

Inherited from Any

Ungrouped