Endpoints

Value Members

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

   

   Definition Classes

   AnyRef → Any

2. final def ##(): Int

   

   Definition Classes

   AnyRef → Any

3. object * extends Endpoint[HNil]

   

   An Endpoint that skips all path segments.

4. object / extends Endpoint[HNil]

   

   An identity Endpoint.

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

   

   Definition Classes

   AnyRef → Any

6. final def asInstanceOf[T0]: T0

   

   Definition Classes

   Any

7. 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.

8. 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.

9. 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.

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

    

    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.

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

    

    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.

12. object boolean extends Extractor[Boolean]

    

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

13. implicit def booleanToMatcher(b: Boolean): Endpoint0

    

14. object booleans extends TailExtractor[Boolean]

    

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

15. def clone(): AnyRef

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

16. 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.

17. 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.

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

    

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

19. 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.

20. final def eq(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

21. def equals(arg0: Any): Boolean

    

    Definition Classes

    AnyRef → Any

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

    

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

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

    

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

24. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

25. 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.

26. final def getClass(): Class[_]

    

    Definition Classes

    AnyRef → Any

27. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

28. 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.

29. 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.

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

    

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

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

    

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

32. object int extends Extractor[Int]

    

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

33. implicit def intToMatcher(i: Int): Endpoint0

    

34. object ints extends TailExtractor[Int]

    

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

35. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

36. def jsonBody[A](implicit arg0: Json[A], arg1: ClassTag[A]): Endpoint[A]

    

    Alias for body[A, Application.Json].

37. def jsonBodyOption[A](implicit arg0: Json[A], arg1: ClassTag[A]): Endpoint[Option[A]]

    

    Alias for bodyOption[A, Application.Json].

38. object long extends Extractor[Long]

    

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

39. object longs extends TailExtractor[Long]

    

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

40. final def ne(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

41. final def notify(): Unit

    

    Definition Classes

    AnyRef

42. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

43. 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.

44. 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.

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

    

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

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

    

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

47. 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.

48. def paramsNel(name: String): Endpoint[NonEmptyList[String]]

    

    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.

49. 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.

50. def path[A](implicit c: DecodePath[A]): Endpoint[A]

    

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

51. val path: Endpoint[String]

    

    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.

    Note

    This is an experimental API and might be removed without any notice.

52. 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.

53. 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.

54. val root: Endpoint[Request]

    

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

55. object string extends StringExtractor

    

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

56. 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.

57. val stringBodyOption: 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.

58. implicit def stringToMatcher(s: String): Endpoint0

    

59. object strings extends TailExtractor[String]

    

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

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

    

    Definition Classes

    AnyRef

61. def textBody[A](implicit arg0: Text[A], arg1: ClassTag[A]): Endpoint[A]

    

    Alias for body[A, Text.Plain]

62. def textBodyOption[A](implicit arg0: Text[A], arg1: ClassTag[A]): Endpoint[Option[A]]

    

    Alias for bodyOption[A, Text.Plain]

63. def toString(): String

    

    Definition Classes

    AnyRef → Any

64. 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.

65. object uuid extends Extractor[UUID]

    

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

66. object uuids extends TailExtractor[UUID]

    

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

67. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

69. final def wait(arg0: Long): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )