trait Endpoints extends Bodies with Paths with Headers with ParamAndParams with Cookies with FileUploadsAndAttributes
- Alphabetic
- By Inheritance
- Endpoints
- FileUploadsAndAttributes
- Cookies
- ParamAndParams
- Headers
- Paths
- Bodies
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- def ->[B](y: B): (Endpoints, B)
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
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]. -
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.- Definition Classes
- Bodies
-
val
binaryBodyOption: Endpoint[Option[Array[Byte]]]
An evaluating Endpoint that reads a binary request body, interpreted as a
Array[Byte], into anOption. -
def
body[A, CT](implicit d: Dispatchable[A, CT], ct: ClassTag[A]): Endpoint[A]
An Endpoint that reads the required request body represented as
CT(ContentType) and interpreted asA, or throws an Error.NotPresent exception.An Endpoint that reads the required request body represented as
CT(ContentType) and interpreted asA, or throws an Error.NotPresent exception. The returned Endpoint only matches non-chunked (non-streamed) requests.- Definition Classes
- Bodies
-
def
bodyOption[A, CT](implicit d: Dispatchable[A, CT], ct: ClassTag[A]): Endpoint[Option[A]]
An Endpoint that reads an optional request body represented as
CT(ContentType) and interpreted asA, into anOption. -
implicit
def
booleanToPath(b: Boolean): Endpoint[HNil]
- Definition Classes
- Paths
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
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.
An evaluating Endpoint that reads a required cookie from the request or raises an Error.NotPresent exception when the cookie is missing.
- Definition Classes
- Cookies
-
def
cookieOption(name: String): Endpoint[Option[Cookie]]
An evaluating Endpoint that reads an optional HTTP cookie from the request into an
Option.An evaluating Endpoint that reads an optional HTTP cookie from the request into an
Option.- Definition Classes
- Cookies
- def ensuring(cond: (Endpoints) ⇒ Boolean, msg: ⇒ Any): Endpoints
- def ensuring(cond: (Endpoints) ⇒ Boolean): Endpoints
- def ensuring(cond: Boolean, msg: ⇒ Any): Endpoints
- def ensuring(cond: Boolean): Endpoints
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
- def formatted(fmtstr: String): String
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
header[A](name: String)(implicit d: DecodeEntity[A], tag: ClassTag[A]): Endpoint[A]
An evaluating Endpoint that reads a required HTTP header
namefrom the request or raises an Error.NotPresent exception when the header is missing.An evaluating Endpoint that reads a required HTTP header
namefrom the request or raises an Error.NotPresent exception when the header is missing.- Definition Classes
- Headers
-
def
headerOption[A](name: String)(implicit d: DecodeEntity[A], tag: ClassTag[A]): Endpoint[Option[A]]
An evaluating Endpoint that reads an optional HTTP header
namefrom the request into anOption.An evaluating Endpoint that reads an optional HTTP header
namefrom the request into anOption.- Definition Classes
- Headers
-
implicit
def
intToPath(i: Int): Endpoint[HNil]
- Definition Classes
- Paths
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
jsonBody[A](implicit arg0: Json[A], arg1: ClassTag[A]): Endpoint[A]
Alias for
body[A, Application.Json].Alias for
body[A, Application.Json].- Definition Classes
- Bodies
-
def
jsonBodyOption[A](implicit arg0: Json[A], arg1: ClassTag[A]): Endpoint[Option[A]]
Alias for
bodyOption[A, Application.Json].Alias for
bodyOption[A, Application.Json].- Definition Classes
- Bodies
-
def
multipartAttribute[A](name: String)(implicit d: DecodeEntity[A], tag: ClassTag[A]): Endpoint[A]
An evaluating Endpoint that reads a required attribute from a
multipart/form-datarequest.An evaluating Endpoint that reads a required attribute from a
multipart/form-datarequest.- Definition Classes
- FileUploadsAndAttributes
-
def
multipartAttributeOption[A](name: String)(implicit d: DecodeEntity[A], tag: ClassTag[A]): Endpoint[Option[A]]
An evaluating Endpoint that reads an optional attribute from a
multipart/form-datarequest.An evaluating Endpoint that reads an optional attribute from a
multipart/form-datarequest.- Definition Classes
- FileUploadsAndAttributes
-
def
multipartAttributes[A](name: String)(implicit d: DecodeEntity[A], tag: ClassTag[A]): Endpoint[Seq[A]]
An evaluating Endpoint that reads a required attribute from a
multipart/form-datarequest.An evaluating Endpoint that reads a required attribute from a
multipart/form-datarequest.- Definition Classes
- FileUploadsAndAttributes
-
def
multipartAttributesNel[A](name: String)(implicit d: DecodeEntity[A], t: ClassTag[A]): Endpoint[NonEmptyList[A]]
An evaluating Endpoint that reads a required attribute from a
multipart/form-datarequest.An evaluating Endpoint that reads a required attribute from a
multipart/form-datarequest.- Definition Classes
- FileUploadsAndAttributes
-
def
multipartFileUpload(name: String): Endpoint[FileUpload]
An evaluating Endpoint that reads a required file upload from a
multipart/form-datarequest.An evaluating Endpoint that reads a required file upload from a
multipart/form-datarequest.- Definition Classes
- FileUploadsAndAttributes
-
def
multipartFileUploadOption(name: String): Endpoint[Option[FileUpload]]
An evaluating Endpoint that reads an optional file upload from a
multipart/form-datarequest into anOption.An evaluating Endpoint that reads an optional file upload from a
multipart/form-datarequest into anOption.- Definition Classes
- FileUploadsAndAttributes
-
def
multipartFileUploads(name: String): Endpoint[Seq[FileUpload]]
An evaluating Endpoint that optionally reads multiple file uploads from a
multipart/form-datarequest.An evaluating Endpoint that optionally reads multiple file uploads from a
multipart/form-datarequest.- Definition Classes
- FileUploadsAndAttributes
-
def
multipartFileUploadsNel(name: String): Endpoint[NonEmptyList[FileUpload]]
An evaluating Endpoint that requires multiple file uploads from a
multipart/form-datarequest.An evaluating Endpoint that requires multiple file uploads from a
multipart/form-datarequest.- Definition Classes
- FileUploadsAndAttributes
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
def
param[A](name: String)(implicit d: DecodeEntity[A], tag: ClassTag[A]): Endpoint[A]
An evaluating Endpoint that reads a required query-string param
namefrom the request or raises an Error.NotPresent exception when the param is missing; an Error.NotValid exception is the param is empty.An evaluating Endpoint that reads a required query-string param
namefrom the request or raises an Error.NotPresent exception when the param is missing; an Error.NotValid exception is the param is empty.- Definition Classes
- ParamAndParams
-
def
paramOption[A](name: String)(implicit d: DecodeEntity[A], tag: ClassTag[A]): Endpoint[Option[A]]
An evaluating Endpoint that reads an optional query-string param
namefrom the request into anOption.An evaluating Endpoint that reads an optional query-string param
namefrom the request into anOption.- Definition Classes
- ParamAndParams
-
def
params[A](name: String)(implicit d: DecodeEntity[A], tag: ClassTag[A]): Endpoint[Seq[A]]
An evaluating Endpoint that reads an optional (in a meaning that a resulting
Seqmay be empty) multi-value query-string paramnamefrom the request into aSeq.An evaluating Endpoint that reads an optional (in a meaning that a resulting
Seqmay be empty) multi-value query-string paramnamefrom the request into aSeq.- Definition Classes
- ParamAndParams
-
def
paramsNel[A](name: String)(implicit d: DecodeEntity[A], tag: ClassTag[A]): Endpoint[NonEmptyList[A]]
An evaluating Endpoint that reads a required multi-value query-string param
namefrom the request into aNonEmptyListor raises a Error.NotPresent exception when the params are missing or empty.An evaluating Endpoint that reads a required multi-value query-string param
namefrom the request into aNonEmptyListor raises a Error.NotPresent exception when the params are missing or empty.- Definition Classes
- ParamAndParams
-
def
path(s: String): Endpoint[HNil]
An Endpoint that matches a given string.
An Endpoint that matches a given string.
- Definition Classes
- Paths
-
def
path[A](implicit arg0: DecodePath[A], arg1: ClassTag[A]): Endpoint[A]
A matching Endpoint that reads a value of type
A(using the implicit DecodePath instances defined forA) from the current path segment.A matching Endpoint that reads a value of type
A(using the implicit DecodePath instances defined forA) from the current path segment.- Definition Classes
- Paths
-
def
paths[A](implicit arg0: DecodePath[A], arg1: ClassTag[A]): Endpoint[Seq[A]]
A matching Endpoint that reads a tail value
A(using the implicit DecodePath instances defined forA) from the entire path.A matching Endpoint that reads a tail value
A(using the implicit DecodePath instances defined forA) from the entire path.- Definition Classes
- Paths
-
val
stringBody: Endpoint[String]
An evaluating Endpoint that reads the required request body, interpreted as a
String, or throws an Error.NotPresent exception.An evaluating Endpoint 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.- Definition Classes
- Bodies
-
val
stringBodyOption: Endpoint[Option[String]]
An evaluating Endpoint that reads an optional request body, interpreted as a
String, into anOption. -
implicit
def
stringToPath(s: String): Endpoint[HNil]
- Definition Classes
- Paths
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
textBody[A](implicit arg0: Decode.Text[A], arg1: ClassTag[A]): Endpoint[A]
Alias for
body[A, Text.Plain]Alias for
body[A, Text.Plain]- Definition Classes
- Bodies
-
def
textBodyOption[A](implicit arg0: Decode.Text[A], arg1: ClassTag[A]): Endpoint[Option[A]]
Alias for
bodyOption[A, Text.Plain]Alias for
bodyOption[A, Text.Plain]- Definition Classes
- Bodies
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
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
- @native() @throws( ... )
- def →[B](y: B): (Endpoints, B)
-
object
* extends Endpoint[HNil]
An Endpoint that skips all path segments.
-
object
/ extends Endpoint[HNil]
An identity Endpoint.
-
object
root extends Endpoint[Request]
A root Endpoint that always matches and extracts the current request.
This is the API documentation for finch
Finch is a thin layer of purely functional basic blocks atop of [Finagle][finagle] for building composable HTTP APIs. Its mission is to provide the developers simple and robust HTTP primitives being as close as possible to the bare metal Finagle API.
Finch uses multi-project structure and contains of the following _modules_:
Please refer to the documentation for a more detailed introduction to the library.