Trait

io.finch

Endpoints

Related Doc: package finch

Permalink

trait Endpoints extends Bodies with Paths with Headers with ParamAndParams with Cookies with FileUploadsAndAttributes

A collection of Endpoint combinators.

Linear Supertypes
FileUploadsAndAttributes, Cookies, ParamAndParams, Headers, Paths, Bodies, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Endpoints
  2. FileUploadsAndAttributes
  3. Cookies
  4. ParamAndParams
  5. Headers
  6. Paths
  7. Bodies
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean

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

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

    Permalink

    An Endpoint that skips all path segments.

  4. object / extends Endpoint[HNil]

    Permalink

    An identity Endpoint.

  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. val asyncBody: Endpoint[AsyncStream[Buf]]

    Permalink

    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.

    Definition Classes
    Bodies
  8. val binaryBody: Endpoint[Array[Byte]]

    Permalink

    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
  9. val binaryBodyOption: Endpoint[Option[Array[Byte]]]

    Permalink

    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.

    Definition Classes
    Bodies
  10. def body[A, CT <: String](implicit d: Aux[A, CT], ct: ClassTag[A]): Endpoint[A]

    Permalink

    An Endpoint that reads the required request body represented as CT (ContentType) and interpreted as A, or throws an Error.NotPresent exception.

    An Endpoint that reads the required request body represented as CT (ContentType) and interpreted as A, or throws an Error.NotPresent exception. The returned Endpoint only matches non-chunked (non-streamed) requests.

    Definition Classes
    Bodies
  11. def bodyOption[A, CT <: String](implicit d: Aux[A, CT], ct: ClassTag[A]): Endpoint[Option[A]]

    Permalink

    An Endpoint that reads an optional request body represented as CT (ContentType) and interpreted as A, into an Option.

    An Endpoint that reads an optional request body represented as CT (ContentType) and interpreted as A, into an Option. The returned Endpoint only matches non-chunked (non-streamed) requests.

    Definition Classes
    Bodies
  12. implicit def booleanToPath(b: Boolean): Endpoint[HNil]

    Permalink
    Definition Classes
    Paths
  13. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  14. def cookie(name: String): Endpoint[Cookie]

    Permalink

    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
  15. def cookieOption(name: String): Endpoint[Option[Cookie]]

    Permalink

    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
  16. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  17. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  18. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  20. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  21. def header[A](name: String)(implicit d: DecodeEntity[A], tag: ClassTag[A]): Endpoint[A]

    Permalink

    An evaluating Endpoint that reads a required HTTP header name from the request or raises an Error.NotPresent exception when the header is missing.

    An evaluating Endpoint that reads a required HTTP header name from the request or raises an Error.NotPresent exception when the header is missing.

    Definition Classes
    Headers
  22. def headerExists[A](name: String)(implicit d: DecodeEntity[A], tag: ClassTag[A]): Endpoint[A]

    Permalink

    A matching Endpoint that only matches the requests that contain a given header name.

    A matching Endpoint that only matches the requests that contain a given header name.

    Definition Classes
    Headers
  23. def headerOption[A](name: String)(implicit d: DecodeEntity[A], tag: ClassTag[A]): Endpoint[Option[A]]

    Permalink

    An evaluating Endpoint that reads an optional HTTP header name from the request into an Option.

    An evaluating Endpoint that reads an optional HTTP header name from the request into an Option.

    Definition Classes
    Headers
  24. implicit def intToPath(i: Int): Endpoint[HNil]

    Permalink
    Definition Classes
    Paths
  25. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  26. def jsonBody[A](implicit arg0: Json[A], arg1: ClassTag[A]): Endpoint[A]

    Permalink

    Alias for body[A, Application.Json].

    Alias for body[A, Application.Json].

    Definition Classes
    Bodies
  27. def jsonBodyOption[A](implicit arg0: Json[A], arg1: ClassTag[A]): Endpoint[Option[A]]

    Permalink

    Alias for bodyOption[A, Application.Json].

    Alias for bodyOption[A, Application.Json].

    Definition Classes
    Bodies
  28. def multipartAttribute[A](name: String)(implicit d: DecodeEntity[A], tag: ClassTag[A]): Endpoint[A]

    Permalink

    An evaluating Endpoint that reads a required attribute from a multipart/form-data request.

    An evaluating Endpoint that reads a required attribute from a multipart/form-data request.

    Definition Classes
    FileUploadsAndAttributes
  29. def multipartAttributeOption[A](name: String)(implicit d: DecodeEntity[A], tag: ClassTag[A]): Endpoint[Option[A]]

    Permalink

    An evaluating Endpoint that reads an optional attribute from a multipart/form-data request.

    An evaluating Endpoint that reads an optional attribute from a multipart/form-data request.

    Definition Classes
    FileUploadsAndAttributes
  30. def multipartAttributes[A](name: String)(implicit d: DecodeEntity[A], tag: ClassTag[A]): Endpoint[Seq[A]]

    Permalink

    An evaluating Endpoint that reads a required attribute from a multipart/form-data request.

    An evaluating Endpoint that reads a required attribute from a multipart/form-data request.

    Definition Classes
    FileUploadsAndAttributes
  31. def multipartAttributesNel[A](name: String)(implicit d: DecodeEntity[A], t: ClassTag[A]): Endpoint[NonEmptyList[A]]

    Permalink

    An evaluating Endpoint that reads a required attribute from a multipart/form-data request.

    An evaluating Endpoint that reads a required attribute from a multipart/form-data request.

    Definition Classes
    FileUploadsAndAttributes
  32. def multipartFileUpload(name: String): Endpoint[FileUpload]

    Permalink

    An evaluating Endpoint that reads a required file upload from a multipart/form-data request.

    An evaluating Endpoint that reads a required file upload from a multipart/form-data request.

    Definition Classes
    FileUploadsAndAttributes
  33. def multipartFileUploadOption(name: String): Endpoint[Option[FileUpload]]

    Permalink

    An evaluating Endpoint that reads an optional file upload from a multipart/form-data request into an Option.

    An evaluating Endpoint that reads an optional file upload from a multipart/form-data request into an Option.

    Definition Classes
    FileUploadsAndAttributes
  34. def multipartFileUploads(name: String): Endpoint[Seq[FileUpload]]

    Permalink

    An evaluating Endpoint that optionally reads multiple file uploads from a multipart/form-data request.

    An evaluating Endpoint that optionally reads multiple file uploads from a multipart/form-data request.

    Definition Classes
    FileUploadsAndAttributes
  35. def multipartFileUploadsNel(name: String): Endpoint[NonEmptyList[FileUpload]]

    Permalink

    An evaluating Endpoint that requires multiple file uploads from a multipart/form-data request.

    An evaluating Endpoint that requires multiple file uploads from a multipart/form-data request.

    Definition Classes
    FileUploadsAndAttributes
  36. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  37. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  38. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  39. def param[A](name: String)(implicit d: DecodeEntity[A], tag: ClassTag[A]): Endpoint[A]

    Permalink

    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.

    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.

    Definition Classes
    ParamAndParams
  40. def paramExists[A](name: String)(implicit d: DecodeEntity[A], tag: ClassTag[A]): Endpoint[A]

    Permalink

    A matching Endpoint that only matches the requests that contain a given query-string param name.

    A matching Endpoint that only matches the requests that contain a given query-string param name.

    Definition Classes
    ParamAndParams
  41. def paramOption[A](name: String)(implicit d: DecodeEntity[A], tag: ClassTag[A]): Endpoint[Option[A]]

    Permalink

    An evaluating Endpoint that reads an optional query-string param name from the request into an Option.

    An evaluating Endpoint that reads an optional query-string param name from the request into an Option.

    Definition Classes
    ParamAndParams
  42. def params[A](name: String)(implicit d: DecodeEntity[A], tag: ClassTag[A]): Endpoint[Seq[A]]

    Permalink

    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.

    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.

    Definition Classes
    ParamAndParams
  43. def paramsNel[A](name: String)(implicit d: DecodeEntity[A], tag: ClassTag[A]): Endpoint[NonEmptyList[A]]

    Permalink

    An evaluating Endpoint that reads a required multi-value query-string param name from the request into a NonEmptyList or raises a Error.NotPresent exception when the params are missing or empty.

    An evaluating Endpoint that reads a required multi-value query-string param name from the request into a NonEmptyList or raises a Error.NotPresent exception when the params are missing or empty.

    Definition Classes
    ParamAndParams
  44. def path(s: String): Endpoint[HNil]

    Permalink

    An Endpoint that matches a given string.

    An Endpoint that matches a given string.

    Definition Classes
    Paths
  45. def path[A](implicit arg0: DecodePath[A], arg1: ClassTag[A]): Endpoint[A]

    Permalink

    A matching Endpoint that reads a value of type A (using the implicit DecodePath instances defined for A) from the current path segment.

    A matching Endpoint that reads a value of type A (using the implicit DecodePath instances defined for A) from the current path segment.

    Definition Classes
    Paths
  46. def paths[A](implicit arg0: DecodePath[A], arg1: ClassTag[A]): Endpoint[Seq[A]]

    Permalink

    A matching Endpoint that reads a tail value A (using the implicit DecodePath instances defined for A) from the entire path.

    A matching Endpoint that reads a tail value A (using the implicit DecodePath instances defined for A) from the entire path.

    Definition Classes
    Paths
  47. object root extends Endpoint[Request]

    Permalink

    A root Endpoint that always matches and extracts the current request.

  48. val stringBody: Endpoint[String]

    Permalink

    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
  49. val stringBodyOption: Endpoint[Option[String]]

    Permalink

    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.

    Definition Classes
    Bodies
  50. implicit def stringToPath(s: String): Endpoint[HNil]

    Permalink
    Definition Classes
    Paths
  51. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  52. def textBody[A](implicit arg0: Text[A], arg1: ClassTag[A]): Endpoint[A]

    Permalink

    Alias for body[A, Text.Plain]

    Alias for body[A, Text.Plain]

    Definition Classes
    Bodies
  53. def textBodyOption[A](implicit arg0: Text[A], arg1: ClassTag[A]): Endpoint[Option[A]]

    Permalink

    Alias for bodyOption[A, Text.Plain]

    Alias for bodyOption[A, Text.Plain]

    Definition Classes
    Bodies
  54. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  55. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def boolean(name: String): Endpoint[Boolean]

    Permalink

    A matching Endpoint that reads a boolean value from the current path segment.

    A matching Endpoint that reads a boolean value from the current path segment.

    Definition Classes
    Paths
    Annotations
    @deprecated
    Deprecated

    (Since version 0.16) Use path[Boolean].withToString(String) instead

  2. val boolean: Endpoint[Boolean]

    Permalink

    A matching Endpoint that reads a boolean value from the current path segment.

    A matching Endpoint that reads a boolean value from the current path segment.

    Definition Classes
    Paths
    Annotations
    @deprecated
    Deprecated

    (Since version 0.16) Use path[Boolean] instead

  3. val booleans: Endpoint[Seq[Boolean]]

    Permalink

    A matching Endpoint that reads a boolean tail from the current path segment.

    A matching Endpoint that reads a boolean tail from the current path segment.

    Definition Classes
    Paths
    Annotations
    @deprecated
    Deprecated

    (Since version 0.16) Use paths[Boolean] instead

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

    Permalink

    An evaluating Endpoint that reads a required file upload from a multipart/form-data request.

    An evaluating Endpoint that reads a required file upload from a multipart/form-data request.

    Definition Classes
    FileUploadsAndAttributes
    Annotations
    @deprecated
    Deprecated

    (Since version 0.16) Use multipartFileUpload instead

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

    Permalink

    An evaluating Endpoint that reads an optional file upload from a multipart/form-data request into an Option.

    An evaluating Endpoint that reads an optional file upload from a multipart/form-data request into an Option.

    Definition Classes
    FileUploadsAndAttributes
    Annotations
    @deprecated
    Deprecated

    (Since version 0.16) Use multipartFileUploadOption instead

  6. def int(name: String): Endpoint[Int]

    Permalink

    A matching Endpoint that reads an integer value from the current path segment.

    A matching Endpoint that reads an integer value from the current path segment.

    Definition Classes
    Paths
    Annotations
    @deprecated
    Deprecated

    (Since version 0.16) Use path[Int].withToString(String) instead

  7. val int: Endpoint[Int]

    Permalink

    A matching Endpoint that reads an integer value from the current path segment.

    A matching Endpoint that reads an integer value from the current path segment.

    Definition Classes
    Paths
    Annotations
    @deprecated
    Deprecated

    (Since version 0.16) Use path[Int] instead

  8. val ints: Endpoint[Seq[Int]]

    Permalink

    A matching Endpoint that reads a string tail from the current path segment.

    A matching Endpoint that reads a string tail from the current path segment.

    Definition Classes
    Paths
    Annotations
    @deprecated
    Deprecated

    (Since version 0.16) Use paths[Int] instead

  9. def long(name: String): Endpoint[Long]

    Permalink

    A matching Endpoint that reads a long value from the current path segment.

    A matching Endpoint that reads a long value from the current path segment.

    Definition Classes
    Paths
    Annotations
    @deprecated
    Deprecated

    (Since version 0.16) Use path[Long].withToString(String) instead

  10. val long: Endpoint[Long]

    Permalink

    A matching Endpoint that reads a long value from the current path segment.

    A matching Endpoint that reads a long value from the current path segment.

    Definition Classes
    Paths
    Annotations
    @deprecated
    Deprecated

    (Since version 0.16) Use path[Long] instead

  11. val longs: Endpoint[Seq[Long]]

    Permalink

    A matching Endpoint that reads a long tail from the current path segment.

    A matching Endpoint that reads a long tail from the current path segment.

    Definition Classes
    Paths
    Annotations
    @deprecated
    Deprecated

    (Since version 0.16) Use paths[Long] instead

  12. def string(name: String): Endpoint[String]

    Permalink

    A matching Endpoint that reads a string value from the current path segment.

    A matching Endpoint that reads a string value from the current path segment.

    Definition Classes
    Paths
    Annotations
    @deprecated
    Deprecated

    (Since version 0.16) Use path[String].withToString(String) instead

  13. val string: Endpoint[String]

    Permalink

    A matching Endpoint that reads a string value from the current path segment.

    A matching Endpoint that reads a string value from the current path segment.

    Definition Classes
    Paths
    Annotations
    @deprecated
    Deprecated

    (Since version 0.16) Use path[String] instead

  14. val strings: Endpoint[Seq[String]]

    Permalink

    A matching Endpoint that reads a string tail from the current path segment.

    A matching Endpoint that reads a string tail from the current path segment.

    Definition Classes
    Paths
    Annotations
    @deprecated
    Deprecated

    (Since version 0.16) Use paths[String] instead

  15. def uuid(name: String): Endpoint[UUID]

    Permalink

    A matching Endpoint that reads a UUID value from the current path segment.

    A matching Endpoint that reads a UUID value from the current path segment.

    Definition Classes
    Paths
    Annotations
    @deprecated
    Deprecated

    (Since version 0.16) Use path[UUID].withToString(String) instead

  16. val uuid: Endpoint[UUID]

    Permalink

    A matching Endpoint that reads an UUID value from the current path segment.

    A matching Endpoint that reads an UUID value from the current path segment.

    Definition Classes
    Paths
    Annotations
    @deprecated
    Deprecated

    (Since version 0.16) Use path[UUID] instead

  17. val uuids: Endpoint[Seq[UUID]]

    Permalink

    A matching Endpoint that reads a UUID tail from the current path segment.

    A matching Endpoint that reads a UUID tail from the current path segment.

    Definition Classes
    Paths
    Annotations
    @deprecated
    Deprecated

    (Since version 0.16) Use paths[UUID] instead

Inherited from FileUploadsAndAttributes

Inherited from Cookies

Inherited from ParamAndParams

Inherited from Headers

Inherited from Paths

Inherited from Bodies

Inherited from AnyRef

Inherited from Any

Ungrouped