Trait

io.finch

Endpoints

Related Doc: package finch

Permalink

trait Endpoints extends AnyRef

A collection of Endpoint combinators.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Endpoints
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Type Members

  1. case class BasicAuth(user: String, password: String, err: Map[String, String] = Map.empty[String, String]) extends Product with Serializable

    Permalink

    Maintains Basic HTTP Auth for an arbitrary Endpoint.

  2. type Endpoint0 = Endpoint[HNil]

    Permalink

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

    Permalink

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

    Permalink

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

    Permalink

    An universal extractor that extracts some value of type A if it's possible to fetch the value from the string.

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

    Permalink

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

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

  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. object boolean extends Extractor[Boolean]

    Permalink

    An Endpoint that extract a boolean value from the route.

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

    Permalink

  9. object booleans extends TailExtractor[Boolean]

    Permalink

    An Endpoint that extract a boolean tail from the route.

  10. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink

    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 router succeeds on it.

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

    Permalink

    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 router succeeds on it.

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

    Permalink
    Definition Classes
    AnyRef

  14. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  15. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

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

    Permalink

    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 router succeeds on it.

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

    Permalink
    Definition Classes
    AnyRef → Any

  18. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

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

    Permalink

    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 router succeeds on it.

  20. object int extends Extractor[Int]

    Permalink

    An Endpoint that extract an integer value from the route.

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

    Permalink

  22. object ints extends TailExtractor[Int]

    Permalink

    An Endpoint that extract an integer tail from the route.

  23. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  24. object long extends Extractor[Long]

    Permalink

    An Endpoint that extract a long value from the route.

  25. object longs extends TailExtractor[Long]

    Permalink

    An Endpoint that extract a long tail from the route.

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

    Permalink
    Definition Classes
    AnyRef

  27. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  28. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

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

    Permalink

    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 router succeeds on it.

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

    Permalink

    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 router succeeds on it.

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

    Permalink

    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 router succeeds on it.

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

    Permalink

    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 router succeeds on it.

  33. object string extends Extractor[String]

    Permalink

    An Endpoint that extract a string value from the route.

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

    Permalink

  35. object strings extends TailExtractor[String]

    Permalink

    An Endpoint that extract a string tail from the route.

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

    Permalink
    Definition Classes
    AnyRef

  37. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

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

    Permalink

    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 succeeds on it.

  39. object uuid extends Extractor[UUID]

    Permalink

    An Endpoint that extract an UUID value from the route.

  40. object uuids extends TailExtractor[UUID]

    Permalink

    An Endpoint that extract an UUID tail from the route.

  41. final def wait(): Unit

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

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

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

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

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

Deprecated Value Members

  1. object Connect extends MethodMatcher

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 0.8.5) Use method connect: Endpoint[A] => Endpoint[A] instead

  2. object Delete extends MethodMatcher

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 0.8.5) Use method delete: Endpoint[A] => Endpoint[A] instead

  3. object Get extends MethodMatcher

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 0.8.5) Use method get: Endpoint[A] => Endpoint[A] instead

  4. object Head extends MethodMatcher

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 0.8.5) Use method head: Endpoint[A] => Endpoint[A] instead

  5. object Options extends MethodMatcher

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 0.8.5) Use method options: Endpoint[A] => Endpoint[A] instead

  6. object Patch extends MethodMatcher

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 0.8.5) Use method patch: Endpoint[A] => Endpoint[A] instead

  7. object Post extends MethodMatcher

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 0.8.5) Use method post: Endpoint[A] => Endpoint[A] instead

  8. object Put extends MethodMatcher

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 0.8.5) Use method put: Endpoint[A] => Endpoint[A] instead

  9. object Trace extends MethodMatcher

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 0.8.5) Use method trace: Endpoint[A] => Endpoint[A] instead

  10. def basicAuth[A](user: String, password: String)(e: Endpoint[A]): Endpoint[A]

    Permalink

    A combinator that wraps the given Endpoint with Basic HTTP Auth, configured with credentials user and password.

    A combinator that wraps the given Endpoint with Basic HTTP Auth, configured with credentials user and password.

    Annotations
    @deprecated
    Deprecated

    (Since version 0.8.5) Use BasicAuth instead

Inherited from AnyRef

Inherited from Any

Ungrouped