snunit-cask/cask.endpoints/options

options

class options(val path: String, val subpath: Boolean) extends WebEndpoint
trait HttpEndpoint[Raw, Seq[String]]
trait Endpoint[Raw, Raw, Seq[String]]
trait Decorator[Raw, Raw, Seq[String]]
class Annotation
class Object
trait Matchable
class Any

Type members

Inherited types

final type Delegate = Map[String, Input] => Result[InnerReturned]
Inherited from:
Decorator
type InputParser[T] = QueryParamReader[T]
Inherited from:
WebEndpoint
final type InputTypeAlias = Input
Inherited from:
Decorator

Value members

Inherited methods

def convertToResultType[T](t: T)(implicit f: Conversion[T, Raw]): InnerReturned
Inherited from:
Endpoint
def getParamParser[T](implicit p: QueryParamReader[T]): InputParser[T]
Inherited from:
Decorator
def wrapFunction(ctx: Request, delegate: Delegate): Result[Raw]
Inherited from:
WebEndpoint
def wrapPathSegment(s: String): Seq[String]

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.

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.

Inherited from:
WebEndpoint

Concrete fields

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?

val path: String

What is the path that this particular endpoint matches?

What is the path that this particular endpoint matches?

override val 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. have an endpoint match URLs with paths in a filesystem (real or virtual) to serve files

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