io.finch

Endpoint

trait Endpoint[Req <: HttpRequest, Rep] extends AnyRef

A REST API endpoint that primary defines a route and might be converted into a finagled service with toService method.

Rep

a response type

Self Type
Endpoint[Req, Rep]
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Endpoint
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def route: PartialFunction[(Method, Path), Service[Req, Rep]]

    A rich route of this endpoint.

    A rich route of this endpoint.

    returns

    a route of this endpoint

Concrete Value Members

  1. def ![RepOut](next: Service[Rep, RepOut]): Endpoint[Req, RepOut]

    Composes this endpoint with given next service.

    Composes this endpoint with given next service.

    RepOut

    the response type

    next

    the service to compose

    returns

    an endpoint composed with filter

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

    Definition Classes
    AnyRef → Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

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

    Definition Classes
    AnyRef → Any

  5. def andThen[ReqOut <: HttpRequest, RepOut](fn: (Service[Req, Rep]) ⇒ Service[ReqOut, RepOut]): Endpoint[ReqOut, RepOut]

    Applies given function fn to every route's endpoints of this endpoint.

    Applies given function fn to every route's endpoints of this endpoint.

    fn

    the function to be applied

    returns

    a new endpoint

  6. def apply(req: Req): Future[Rep]

    Sends a request req to this Endpoint.

    Sends a request req to this Endpoint.

    req

    the request to send

    returns

    a response wrapped with Future

  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  8. def clone(): AnyRef

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

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

    Definition Classes
    AnyRef

  10. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  11. def finalize(): Unit

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

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

    Definition Classes
    AnyRef → Any

  13. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  14. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

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

    Definition Classes
    AnyRef

  16. final def notify(): Unit

    Definition Classes
    AnyRef

  17. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  18. def orElse(that: PartialFunction[(Method, Path), Service[Req, Rep]]): Endpoint[Req, Rep]

    Combines this endpoint with that partial function that defines a route.

    Combines this endpoint with that partial function that defines a route. A new endpoint contains routes of both this endpoint and that partial function

    that

    the partial function to be combined with

    returns

    a new endpoint

  19. def orElse(that: Endpoint[Req, Rep]): Endpoint[Req, Rep]

    Combines this endpoint with that endpoint.

    Combines this endpoint with that endpoint. A new endpoint contains routes of both this and that endpoint.

    that

    the endpoint to be combined with

    returns

    a new endpoint

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

    Definition Classes
    AnyRef

  21. def toService: Service[Req, Rep]

    Converts this endpoint into a finagled service.

    Converts this endpoint into a finagled service.

    returns

    a finagled service

  22. def toString(): String

    Definition Classes
    AnyRef → Any

  23. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped