Package

io.finch

syntax

Permalink

package syntax

Enables Sinatra-like syntax extensions for endpoints.

Linear Supertypes
EndpointMappers, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. syntax
  2. EndpointMappers
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. class EndpointMapper[A] extends Endpoint[A]

    Permalink
  2. trait Mapper[A] extends AnyRef

    Permalink

    A type class that allows the Endpoint to be mapped to either A => B or A => Future[B].

Value Members

  1. object Mapper extends HighPriorityMapperConversions

    Permalink
  2. def connect[A](e: Endpoint[A]): EndpointMapper[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 endpoint succeeds on it.

    Definition Classes
    EndpointMappers
  3. def delete[A](e: Endpoint[A]): EndpointMapper[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 endpoint succeeds on it.

    Definition Classes
    EndpointMappers
  4. def get[A](e: Endpoint[A]): EndpointMapper[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 endpoint succeeds on it.

    Definition Classes
    EndpointMappers
  5. def head[A](e: Endpoint[A]): EndpointMapper[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 endpoint succeeds on it.

    Definition Classes
    EndpointMappers
  6. def options[A](e: Endpoint[A]): EndpointMapper[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 endpoint succeeds on it.

    Definition Classes
    EndpointMappers
  7. def patch[A](e: Endpoint[A]): EndpointMapper[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 endpoint succeeds on it.

    Definition Classes
    EndpointMappers
  8. def post[A](e: Endpoint[A]): EndpointMapper[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 endpoint succeeds on it.

    Definition Classes
    EndpointMappers
  9. def put[A](e: Endpoint[A]): EndpointMapper[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 endpoint succeeds on it.

    Definition Classes
    EndpointMappers
  10. def trace[A](e: Endpoint[A]): EndpointMapper[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 endpoint on it.

    Definition Classes
    EndpointMappers

Inherited from EndpointMappers

Inherited from AnyRef

Inherited from Any

Ungrouped