trait HttpEndpoint[InnerReturned, Input] extends Endpoint[InnerReturned, Input]
Annotates a Cask endpoint that returns a HTTP Response; similar to a RawDecorator but with additional metadata and capabilities.
- Alphabetic
- By Inheritance
- HttpEndpoint
- Endpoint
- Decorator
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
- final type Delegate = (Map[String, Input]) => Result[InnerReturned]
- Definition Classes
- Decorator
- abstract type InputParser[T] <: ArgReader[Input, T, model.Request]
- Definition Classes
- Decorator
- final type InputTypeAlias = Input
- Definition Classes
- Decorator
- type OuterReturned = Result[Raw]
- Definition Classes
- HttpEndpoint → Decorator
Abstract Value Members
- abstract val methods: Seq[String]
Which HTTP methods does this endpoint support? POST? GET? PUT? Or some combination of those?
Which HTTP methods does this endpoint support? POST? GET? PUT? Or some combination of those?
- Definition Classes
- Endpoint
- abstract val path: String
What is the path that this particular endpoint matches?
What is the path that this particular endpoint matches?
- Definition Classes
- Endpoint
- abstract def wrapFunction(ctx: model.Request, delegate: Delegate): OuterReturned
- Definition Classes
- Decorator
- 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/:worldto(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.- Definition Classes
- Endpoint
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##(): Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- def convertToResultType[T](t: T)(implicit f: Conversion[T, InnerReturned]): InnerReturned
- Definition Classes
- Endpoint
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def getParamParser[T](implicit p: InputParser[T]): InputParser[T]
- Definition Classes
- Decorator
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- 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- Definition Classes
- Endpoint
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()