io.finch

route

package route

This package contains various of functions and types that enable _router combinators_ in Finch. Finch's io.finch.Endpoint is an abstraction that is responsible for routing the HTTP requests using their method and path information.

Please note that this package is deprecated since 0.9.1.

Linear Supertypes
Endpoints, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. route
  2. Endpoints
  3. AnyRef
  4. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

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

    Maintains Basic HTTP Auth for an arbitrary Endpoint.

  2. type Endpoint0 = Endpoint[HNil]

    Definition Classes
    Endpoints

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

    Definition Classes
    Endpoints

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

    Definition Classes
    Endpoints

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

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

  7. type Router[A] = Endpoint[A]

    Annotations
    @deprecated
    Deprecated

    (Since version 0.9.1) Use io.finch.Endpoint instead

  8. type Router0 = Endpoint[HNil]

    Annotations
    @deprecated
    Deprecated

    (Since version 0.9.1) Use io.finch.Endpoint0 instead

  9. type Router2[A, B] = Endpoint[::[A, ::[B, HNil]]]

    Annotations
    @deprecated
    Deprecated

    (Since version 0.9.1) Use io.finch.Endpoint2 instead

  10. type Router3[A, B, C] = Endpoint[::[A, ::[B, ::[C, HNil]]]]

    Annotations
    @deprecated
    Deprecated

    (Since version 0.9.1) Use io.finch.Endpoint3 instead

Value Members

  1. object * extends Endpoint[HNil]

    An Endpoint that skips all path parts.

  2. object / extends Endpoint[HNil]

    An identity Endpoint.

  3. object boolean extends Extractor[Boolean]

    An Endpoint that extract a boolean value from the route.

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

    Definition Classes
    Endpoints

  5. object booleans extends TailExtractor[Boolean]

    An Endpoint that extract a boolean tail from the route.

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

    Definition Classes
    Endpoints

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

    Definition Classes
    Endpoints

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

    Definition Classes
    Endpoints

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

    Definition Classes
    Endpoints

  10. object int extends Extractor[Int]

    An Endpoint that extract an integer value from the route.

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

    Definition Classes
    Endpoints

  12. object ints extends TailExtractor[Int]

    An Endpoint that extract an integer tail from the route.

  13. object long extends Extractor[Long]

    An Endpoint that extract a long value from the route.

  14. object longs extends TailExtractor[Long]

    An Endpoint that extract a long tail from the route.

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

    Definition Classes
    Endpoints

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

    Definition Classes
    Endpoints

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

    Definition Classes
    Endpoints

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

    Definition Classes
    Endpoints

  19. object string extends Extractor[String]

    An Endpoint that extract a string value from the route.

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

    Definition Classes
    Endpoints

  21. object strings extends TailExtractor[String]

    An Endpoint that extract a string tail from the route.

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

    Definition Classes
    Endpoints

  23. object uuid extends Extractor[UUID]

    An Endpoint that extract an UUID value from the route.

  24. object uuids extends TailExtractor[UUID]

    An Endpoint that extract an UUID tail from the route.

Deprecated Value Members

  1. object Connect extends MethodMatcher

    Definition Classes
    Endpoints
    Annotations
    @deprecated
    Deprecated

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

  2. object Delete extends MethodMatcher

    Definition Classes
    Endpoints
    Annotations
    @deprecated
    Deprecated

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

  3. object Get extends MethodMatcher

    Definition Classes
    Endpoints
    Annotations
    @deprecated
    Deprecated

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

  4. object Head extends MethodMatcher

    Definition Classes
    Endpoints
    Annotations
    @deprecated
    Deprecated

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

  5. object Options extends MethodMatcher

    Definition Classes
    Endpoints
    Annotations
    @deprecated
    Deprecated

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

  6. object Patch extends MethodMatcher

    Definition Classes
    Endpoints
    Annotations
    @deprecated
    Deprecated

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

  7. object Post extends MethodMatcher

    Definition Classes
    Endpoints
    Annotations
    @deprecated
    Deprecated

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

  8. object Put extends MethodMatcher

    Definition Classes
    Endpoints
    Annotations
    @deprecated
    Deprecated

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

  9. val Router: Endpoint.type

    Annotations
    @deprecated
    Deprecated

    (Since version 0.9.1) Use io.finch.Endpoint instead

  10. object Trace extends MethodMatcher

    Definition Classes
    Endpoints
    Annotations
    @deprecated
    Deprecated

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

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

    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.

    Definition Classes
    Endpoints
    Annotations
    @deprecated
    Deprecated

    (Since version 0.9.1) Use BasicAuth instead

Inherited from Endpoints

Inherited from AnyRef

Inherited from Any

Ungrouped