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 argonaut
    Definition Classes
    finch
  • Decoders
  • Encoders
  • dropNullKeys
  • preserveOrder
  • preserveOrderAndDropNullKeys
  • package circe
    Definition Classes
    finch
  • package div
    Definition Classes
    finch
  • package generic
    Definition Classes
    finch
  • package internal

    This package contains an internal-use only type-classes and utilities that power Finch's API.

    This package contains an internal-use only type-classes and utilities that power Finch's API.

    It's not recommended to use any of the internal API directly, since it might change without any deprecation cycles.

    Definition Classes
    finch
  • package iteratee

    Iteratee module

    Iteratee module

    Definition Classes
    finch
  • package refined
    Definition Classes
    finch
  • package sse
    Definition Classes
    finch
  • package streaming
    Definition Classes
    finch
  • package syntax

    Enables Sinatra-like syntax extensions for endpoints.

    Enables Sinatra-like syntax extensions for endpoints.

    Definition Classes
    finch
  • package test
    Definition Classes
    finch
  • package todo
    Definition Classes
    finch
  • package wrk
    Definition Classes
    finch
p

io.finch

argonaut

package argonaut

Source
package.scala
Linear Supertypes
Decoders, Encoders, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. argonaut
  2. Decoders
  3. Encoders
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. trait Decoders extends AnyRef
  2. trait Encoders extends AnyRef

Abstract Value Members

  1. abstract def printer: PrettyParams
    Attributes
    protected
    Definition Classes
    Encoders

Concrete Value Members

  1. implicit def decodeArgonaut[A](implicit d: DecodeJson[A]): Json[A]

    Maps Argonaut's DecodeJson to Finch's Decode.

    Maps Argonaut's DecodeJson to Finch's Decode.

    Definition Classes
    Decoders
  2. implicit def encodeArgonaut[A](implicit e: EncodeJson[A]): Encode.Json[A]

    Maps Argonaut's EncodeJson to Finch's Encode.

    Maps Argonaut's EncodeJson to Finch's Encode.

    Definition Classes
    Encoders
  3. object dropNullKeys extends Encoders with Decoders
  4. object preserveOrder extends Encoders with Decoders

    Provides an implicit PrettyParams that preserves order of the JSON fields.

  5. object preserveOrderAndDropNullKeys extends Encoders with Decoders

    Provides an implicit PrettyParams that both preserves order of the JSON fields and drop null keys.

Inherited from Decoders

Inherited from Encoders

Inherited from AnyRef

Inherited from Any

Ungrouped