Packages

  • package root

    This is the API documentation for finch

    This is the API documentation for finch

    Finch is a thin layer of purely functional basic blocks atop of [Finagle][finagle] for building composable HTTP APIs. Its mission is to provide the developers simple and robust HTTP primitives being as close as possible to the bare metal Finagle API.

    Finch uses multi-project structure and contains of the following _modules_:

    • core - the core classes/functions
    • argonaut - the JSON API support for the [Argonaut][argonaut] library
    • jackson - the JSON API support for the [Jackson][jackson] library
    • json4s - the JSON API support for the [JSON4S][json4s] library
    • circe - the JSON API support for the [Circe][circe] library
    • playjson - The JSON API support for the [PlayJson][playjson] library
    • sprayjson - The JSON API support for the [SprayJson][sprayjson] library
    • test - the test support classes/functions
    • oauth2 - the OAuth2 support backed by the [finagle-oauth2][finagle-oauth2] library
    • see - SSE ([Server Sent Events][server-sent-events]) support in Finch

    Please refer to the documentation for a more detailed introduction to the library.

    Definition Classes
    root
  • package io
    Definition Classes
    root
  • package finch

    This is a root package of the Finch library, which provides an immutable layer of functions and types atop of Finagle for writing lightweight HTTP services.

    This is a root package of the Finch library, which provides an immutable layer of functions and types atop of Finagle for writing lightweight HTTP services.

    Definition Classes
    io
  • package syntax

    Enables Sinatra-like syntax extensions for endpoints.

    Enables Sinatra-like syntax extensions for endpoints.

    Definition Classes
    finch
  • EndpointMapper
  • Mapper
  • ToTwitterFuture
  • scalaFutures

trait Mapper[A] extends AnyRef

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

Source
Mapper.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Mapper
  2. AnyRef
  3. Any
Implicitly
  1. by mapperFromFutureResponseHFunction
  2. by mapperFromFutureOutputHFunction
  3. by mapperFromResponseHFunction
  4. by mapperFromOutputHFunction
  5. by any2stringadd
  6. by StringFormat
  7. by Ensuring
  8. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. abstract type Out

Abstract Value Members

  1. abstract def apply(e: Endpoint[A]): Endpoint[Out]

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from Mapper[A] to any2stringadd[Mapper[A]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Mapper[A], B)
    Implicit
    This member is added by an implicit conversion from Mapper[A] to ArrowAssoc[Mapper[A]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  8. def ensuring(cond: (Mapper[A]) ⇒ Boolean, msg: ⇒ Any): Mapper[A]
    Implicit
    This member is added by an implicit conversion from Mapper[A] to Ensuring[Mapper[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (Mapper[A]) ⇒ Boolean): Mapper[A]
    Implicit
    This member is added by an implicit conversion from Mapper[A] to Ensuring[Mapper[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: ⇒ Any): Mapper[A]
    Implicit
    This member is added by an implicit conversion from Mapper[A] to Ensuring[Mapper[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): Mapper[A]
    Implicit
    This member is added by an implicit conversion from Mapper[A] to Ensuring[Mapper[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Mapper[A] to StringFormat[Mapper[A]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  16. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  23. def toString(): String
    Definition Classes
    AnyRef → Any
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  27. def →[B](y: B): (Mapper[A], B)
    Implicit
    This member is added by an implicit conversion from Mapper[A] to ArrowAssoc[Mapper[A]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. def apply(e: Endpoint[A]): Endpoint[Response]
    Implicit
    This member is added by an implicit conversion from Mapper[A] to Mapper.Aux[A, Response] performed by method mapperFromFutureResponseHFunction in io.finch.syntax.Mapper.
    This conversion will take place only if all of the following constraints are met:
    1. an implicit value of type shapeless.ops.function.FnToProduct.Aux[Mapper[A], (A) ⇒ FR] is in scope
    2. an implicit value of type <:<[FR, H[Response]] is in scope
    3. an implicit value of type ToTwitterFuture[H] is in scope
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (mapper: Mapper.Aux[A, Response]).apply(e)
  2. def apply(e: Endpoint[A]): Endpoint[B]
    Implicit
    This member is added by an implicit conversion from Mapper[A] to Mapper.Aux[A, B] performed by method mapperFromFutureOutputHFunction in io.finch.syntax.Mapper.
    This conversion will take place only if all of the following constraints are met:
    1. an implicit value of type shapeless.ops.function.FnToProduct.Aux[Mapper[A], (A) ⇒ FOB] is in scope
    2. an implicit value of type ToTwitterFuture[H] is in scope
    3. an implicit value of type <:<[FOB, H[Output[B]]] is in scope
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (mapper: Mapper.Aux[A, B]).apply(e)
  3. def apply(e: Endpoint[A]): Endpoint[Response]
    Implicit
    This member is added by an implicit conversion from Mapper[A] to Mapper.Aux[A, Response] performed by method mapperFromResponseHFunction in io.finch.syntax.HighPriorityMapperConversions. This conversion will take place only if an implicit value of type shapeless.ops.function.FnToProduct.Aux[Mapper[A], (A) ⇒ R] is in scope and at the same time an implicit value of type <:<[R, Response] is in scope.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (mapper: Mapper.Aux[A, Response]).apply(e)
  4. def apply(e: Endpoint[A]): Endpoint[B]
    Implicit
    This member is added by an implicit conversion from Mapper[A] to Mapper.Aux[A, B] performed by method mapperFromOutputHFunction in io.finch.syntax.HighPriorityMapperConversions. This conversion will take place only if an implicit value of type shapeless.ops.function.FnToProduct.Aux[Mapper[A], (A) ⇒ OB] is in scope and at the same time an implicit value of type <:<[OB, Output[B]] is in scope.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (mapper: Mapper.Aux[A, B]).apply(e)

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion mapperFromFutureResponseHFunction from Mapper[A] to Mapper.Aux[A, Response]

Inherited by implicit conversion mapperFromFutureOutputHFunction from Mapper[A] to Mapper.Aux[A, B]

Inherited by implicit conversion mapperFromResponseHFunction from Mapper[A] to Mapper.Aux[A, Response]

Inherited by implicit conversion mapperFromOutputHFunction from Mapper[A] to Mapper.Aux[A, B]

Inherited by implicit conversion any2stringadd from Mapper[A] to any2stringadd[Mapper[A]]

Inherited by implicit conversion StringFormat from Mapper[A] to StringFormat[Mapper[A]]

Inherited by implicit conversion Ensuring from Mapper[A] to Ensuring[Mapper[A]]

Inherited by implicit conversion ArrowAssoc from Mapper[A] to ArrowAssoc[Mapper[A]]

Ungrouped