Class/Object

io.finch

Input

Related Docs: object Input | package finch

Permalink

final case class Input(request: Request, route: List[String]) extends Product with Serializable

An input for Endpoint that glues two individual pieces together:

- Finagle's Request needed for evaluating (e.g., body, param) - Finch's route (represented as Seq[String]) needed for matching (e.g., path)

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Input
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Input(request: Request, route: List[String])

    Permalink

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  7. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  8. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  9. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  10. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  11. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  12. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  13. val request: Request

    Permalink
  14. val route: List[String]

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

    Permalink
    Definition Classes
    AnyRef
  16. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  17. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. def withBody[CT <: String]: Body[CT]

    Permalink

    Returns the new Input wrapping a given payload.

    Returns the new Input wrapping a given payload. This requires the content-type as a first type parameter (won't be inferred).

    import io.finch._, io.circe._

    val text = Input.post("/").withBody[Text.Plain]("Text Body") val json = Input.post("/").withBody[Application.Json](Map("json" -> "object"))

    Also possible to create chunked inputs passing a stream as an argument.

    import io.finch._, io.finch.iteratee._, cats.effect.IO, io.iteratee.Enumerator import io.finch.circe._, io.circe.generic.auto._

    val enumerateText = Enumerator.enumerate[IO, String]("foo", "bar") val text = Input.post("/").withBody[Text.Plain](enumerateText)

    val enumerateJson = Enumerate.enumerate[IO, Map[String, String]](Map("foo" - "bar")) val json = Input.post("/").withBody[Application.Json](enumerateJson)

  20. def withForm(params: (String, String)*): Input

    Permalink

    Returns the new Input wrapping a given application/x-www-form-urlencoded payload.

    Returns the new Input wrapping a given application/x-www-form-urlencoded payload.

    Note

    In addition to media type, this will also set charset to UTF-8.

  21. def withHeaders(headers: (String, String)*): Input

    Permalink

    Returns the new Input with headers amended.

  22. def withRoute(route: List[String]): Input

    Permalink

    Returns the new Input wrapping a given route.

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped