Endpoints

Type Members

case class BasicAuth(user: String, password: String) extends Product with Serializable

Maintains Basic HTTP Auth for an arbitrary Endpoint.
type Endpoint0 = Endpoint[HNil]
type Endpoint2[A, B] = Endpoint[::[A, ::[B, HNil]]]
type Endpoint3[A, B, C] = Endpoint[::[A, ::[B, ::[C, HNil]]]]
case class Extractor[A](name: String, f: (String) ⇒ Option[A]) extends Endpoint[A] with Product with Serializable

An universal extractor that extracts some value of type A if it's possible to fetch the value from the string.
case class TailExtractor[A](name: String, f: (String) ⇒ Option[A]) extends Endpoint[Seq[A]] with Product with Serializable

An extractor that extracts a value of type Seq[A] from the tail of the route.
type RequestReader[A] = Endpoint[A]

Annotations
@deprecated
Deprecated
(Since version 0.10.0) RequestReaders are now Endpoints

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
object * extends Endpoint[HNil]

An Endpoint that skips all path segments.
object / extends Endpoint[HNil]

An identity Endpoint.
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
object BasicAuthFailed extends Exception

An Exception representing a failed authorization with BasicAuth.
final def asInstanceOf[T0]: T0

Definition Classes
Any
val asyncBody: Endpoint[AsyncStream[Buf]]

An evaluating Endpoint that reads a required chunked streaming binary body, interpreted as an AsyncStream[Buf].
An evaluating Endpoint that reads a required chunked streaming binary body, interpreted as an AsyncStream[Buf]. The returned Endpoint only matches chunked (streamed) requests.
val binaryBody: Endpoint[Array[Byte]]

An evaluating Endpoint that reads a required binary request body, interpreted as an Array[Byte], or throws a Error.NotPresent exception.
An evaluating Endpoint that reads a required binary request body, interpreted as an Array[Byte], or throws a Error.NotPresent exception. The returned Endpoint only matches non-chunked (non-streamed) requests.
val binaryBodyOption: Endpoint[Option[Array[Byte]]]

An evaluating Endpoint that reads a binary request body, interpreted as a Array[Byte], into an Option.
An evaluating Endpoint that reads a binary request body, interpreted as a Array[Byte], into an Option. The returned Endpoint only matches non-chunked (non-streamed) requests.
val body: Endpoint[String]

An evaluatingEndpoint that reads the required request body, interpreted as a String, or throws an Error.NotPresent exception.
An evaluatingEndpoint that reads the required request body, interpreted as a String, or throws an Error.NotPresent exception. The returned Endpoint only matches non-chunked (non-streamed) requests.
val bodyOption: Endpoint[Option[String]]

An evaluating Endpoint that reads an optional request body, interpreted as a String, into an Option.
An evaluating Endpoint that reads an optional request body, interpreted as a String, into an Option. The returned Endpoint only matches non-chunked (non-streamed) requests.
object boolean extends Extractor[Boolean]

A matching Endpoint that reads a boolean value from the current path segment.
implicit def booleanToMatcher(b: Boolean): Endpoint0
object booleans extends TailExtractor[Boolean]

A matching Endpoint that reads a boolean tail from the current path segment.
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def connect[A]: (Endpoint[A]) ⇒ Endpoint[A]

A combinator that wraps the given Endpoint with additional check of the HTTP method.
A combinator that wraps the given Endpoint with additional check of the HTTP method. The resulting Endpoint succeeds on the request only if its method is CONNECT and the underlying endpoint succeeds on it.
def cookie(name: String): Endpoint[Cookie]

An evaluating Endpoint that reads a required cookie from the request or raises an Error.NotPresent exception when the cookie is missing.
def cookieOption(name: String): Endpoint[Option[Cookie]]

An evaluating Endpoint that reads an optional HTTP cookie from the request into an Option.
def delete[A]: (Endpoint[A]) ⇒ Endpoint[A]

A combinator that wraps the given Endpoint with additional check of the HTTP method.
A combinator that wraps the given Endpoint with additional check of the HTTP method. The resulting Endpoint succeeds on the request only if its method is DELETE and the underlying endpoint succeeds on it.
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def fileUpload(name: String): Endpoint[FileUpload]

An evaluating Endpoint that reads a required file upload from a multipart/form-data request.
def fileUploadOption(name: String): Endpoint[Option[FileUpload]]

An evaluatingEndpoint that reads an optional file upload from a multipart/form-data request into an Option.
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def get[A]: (Endpoint[A]) ⇒ Endpoint[A]

A combinator that wraps the given Endpoint with additional check of the HTTP method.
A combinator that wraps the given Endpoint with additional check of the HTTP method. The resulting Endpoint succeeds on the request only if its method is GET and the underlying endpoint succeeds on it.
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
def head[A]: (Endpoint[A]) ⇒ Endpoint[A]

A combinator that wraps the given Endpoint with additional check of the HTTP method.
A combinator that wraps the given Endpoint with additional check of the HTTP method. The resulting Endpoint succeeds on the request only if its method is HEAD and the underlying endpoint succeeds on it.
def header(name: String): Endpoint[String]

An evaluating Endpoint that reads a required HTTP header name from the request or raises an Error.NotPresent exception when the header is missing.
def headerExists(name: String): Endpoint[String]

A matching Endpoint that only matches the requests that contain a given header name.
def headerOption(name: String): Endpoint[Option[String]]

An evaluating Endpoint that reads an optional HTTP header name from the request into an Option.
object int extends Extractor[Int]

A matching Endpoint that reads an integer value from the current path segment.
implicit def intToMatcher(i: Int): Endpoint0
object ints extends TailExtractor[Int]

A matching Endpoint that reads an integer tail from the current path segment.
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
object long extends Extractor[Long]

A matching Endpoint that reads a long value from the current path segment.
object longs extends TailExtractor[Long]

A matching Endpoint that reads a long tail from the current path segment.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def options[A]: (Endpoint[A]) ⇒ Endpoint[A]

A combinator that wraps the given Endpoint with additional check of the HTTP method.
A combinator that wraps the given Endpoint with additional check of the HTTP method. The resulting Endpoint succeeds on the request only if its method is OPTIONS and the underlying endpoint succeeds on it.
def param(name: String): Endpoint[String]

An evaluating Endpoint that reads a required query-string param name from the request or raises an Error.NotPresent exception when the param is missing; an Error.NotValid exception is the param is empty.
def paramExists(name: String): Endpoint[String]

A matching Endpoint that only matches the requests that contain a given query-string param name.
def paramOption(name: String): Endpoint[Option[String]]

An evaluating Endpoint that reads an optional query-string param name from the request into an Option.
def params(name: String): Endpoint[Seq[String]]

An evaluating Endpoint that reads an optional (in a meaning that a resulting Seq may be empty) multi-value query-string param name from the request into a Seq.
def paramsNonEmpty(name: String): Endpoint[Seq[String]]

An evaluating Endpoint that reads a required (in a meaning that a resulting Seq will have at least one element) multi-value query-string param name from the request into a Seq or raises a Error.NotPresent exception when the params are missing or empty.
def patch[A]: (Endpoint[A]) ⇒ Endpoint[A]

A combinator that wraps the given Endpoint with additional check of the HTTP method.
A combinator that wraps the given Endpoint with additional check of the HTTP method. The resulting Endpoint succeeds on the request only if its method is PATCH and the underlying endpoint succeeds on it.
def post[A]: (Endpoint[A]) ⇒ Endpoint[A]

A combinator that wraps the given Endpoint with additional check of the HTTP method.
A combinator that wraps the given Endpoint with additional check of the HTTP method. The resulting Endpoint succeeds on the request only if its method is POST and the underlying endpoint succeeds on it.
def put[A]: (Endpoint[A]) ⇒ Endpoint[A]

A combinator that wraps the given Endpoint with additional check of the HTTP method.
A combinator that wraps the given Endpoint with additional check of the HTTP method. The resulting Endpoint succeeds on the request only if its method is PUT and the underlying endpoint succeeds on it.
object string extends StringExtractor

A matching Endpoint that reads a string value from the current path segment.
implicit def stringToMatcher(s: String): Endpoint0
object strings extends TailExtractor[String]

A matching Endpoint that reads a string tail from the current path segment.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
def trace[A]: (Endpoint[A]) ⇒ Endpoint[A]

A combinator that wraps the given Endpoint with additional check of the HTTP method.
A combinator that wraps the given Endpoint with additional check of the HTTP method. The resulting Endpoint succeeds on the request only if its method is TRACE and the underlying router endpoint on it.
object uuid extends Extractor[UUID]

A matching Endpoint that reads an UUID value from the current path segment.
object uuids extends TailExtractor[UUID]

A matching Endpoint that reads an UUID tail from the current path segment.
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package finch

trait Endpoints extends AnyRef

Type Members

case class BasicAuth(user: String, password: String) extends Product with Serializable

type Endpoint0 = Endpoint[HNil]

type Endpoint2[A, B] = Endpoint[::[A, ::[B, HNil]]]

type Endpoint3[A, B, C] = Endpoint[::[A, ::[B, ::[C, HNil]]]]

case class Extractor[A](name: String, f: (String) ⇒ Option[A]) extends Endpoint[A] with Product with Serializable

case class TailExtractor[A](name: String, f: (String) ⇒ Option[A]) extends Endpoint[Seq[A]] with Product with Serializable

type RequestReader[A] = Endpoint[A]

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

object * extends Endpoint[HNil]

object / extends Endpoint[HNil]

final def ==(arg0: Any): Boolean

object BasicAuthFailed extends Exception

final def asInstanceOf[T0]: T0

val asyncBody: Endpoint[AsyncStream[Buf]]

val binaryBody: Endpoint[Array[Byte]]

val binaryBodyOption: Endpoint[Option[Array[Byte]]]

val body: Endpoint[String]

val bodyOption: Endpoint[Option[String]]

object boolean extends Extractor[Boolean]

implicit def booleanToMatcher(b: Boolean): Endpoint0

object booleans extends TailExtractor[Boolean]

def clone(): AnyRef

def connect[A]: (Endpoint[A]) ⇒ Endpoint[A]

def cookie(name: String): Endpoint[Cookie]

def cookieOption(name: String): Endpoint[Option[Cookie]]

def delete[A]: (Endpoint[A]) ⇒ Endpoint[A]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def fileUpload(name: String): Endpoint[FileUpload]

def fileUploadOption(name: String): Endpoint[Option[FileUpload]]

def finalize(): Unit

def get[A]: (Endpoint[A]) ⇒ Endpoint[A]

final def getClass(): Class[_]

def hashCode(): Int

def head[A]: (Endpoint[A]) ⇒ Endpoint[A]

def header(name: String): Endpoint[String]

def headerExists(name: String): Endpoint[String]

def headerOption(name: String): Endpoint[Option[String]]

object int extends Extractor[Int]

implicit def intToMatcher(i: Int): Endpoint0

object ints extends TailExtractor[Int]

final def isInstanceOf[T0]: Boolean

object long extends Extractor[Long]

object longs extends TailExtractor[Long]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def options[A]: (Endpoint[A]) ⇒ Endpoint[A]

def param(name: String): Endpoint[String]

def paramExists(name: String): Endpoint[String]

def paramOption(name: String): Endpoint[Option[String]]

def params(name: String): Endpoint[Seq[String]]

def paramsNonEmpty(name: String): Endpoint[Seq[String]]

def patch[A]: (Endpoint[A]) ⇒ Endpoint[A]

def post[A]: (Endpoint[A]) ⇒ Endpoint[A]

def put[A]: (Endpoint[A]) ⇒ Endpoint[A]

object string extends StringExtractor

implicit def stringToMatcher(s: String): Endpoint0

object strings extends TailExtractor[String]

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

def trace[A]: (Endpoint[A]) ⇒ Endpoint[A]

object uuid extends Extractor[UUID]

object uuids extends TailExtractor[UUID]

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped