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
  • object Error extends Serializable
    Definition Classes
    finch
  • NotParsed
  • NotPresent
  • NotValid
c

io.finch.Error

NotValid

final case class NotValid(item: RequestItem, rule: String) extends Error with Product with Serializable

An exception that indicates a broken ValidationRule on the request item.

item

the invalid request item

rule

the rule description

Source
Error.scala
Linear Supertypes
Serializable, Product, Equals, Error, NoStackTrace, Exception, Throwable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. NotValid
  2. Serializable
  3. Product
  4. Equals
  5. Error
  6. NoStackTrace
  7. Exception
  8. Throwable
  9. Serializable
  10. AnyRef
  11. Any
Implicitly
  1. by RichException
  2. by any2stringadd
  3. by StringFormat
  4. by Ensuring
  5. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new NotValid(item: RequestItem, rule: String)

    item

    the invalid request item

    rule

    the rule description

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 NotValid to any2stringadd[NotValid] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (NotValid, B)
    Implicit
    This member is added by an implicit conversion from NotValid to ArrowAssoc[NotValid] 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 addSuppressed(arg0: Throwable): Unit
    Definition Classes
    Throwable
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  9. def ensuring(cond: (NotValid) ⇒ Boolean, msg: ⇒ Any): NotValid
    Implicit
    This member is added by an implicit conversion from NotValid to Ensuring[NotValid] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (NotValid) ⇒ Boolean): NotValid
    Implicit
    This member is added by an implicit conversion from NotValid to Ensuring[NotValid] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: ⇒ Any): NotValid
    Implicit
    This member is added by an implicit conversion from NotValid to Ensuring[NotValid] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): NotValid
    Implicit
    This member is added by an implicit conversion from NotValid to Ensuring[NotValid] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def fillInStackTrace(): Throwable
    Definition Classes
    NoStackTrace → Throwable
  15. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  16. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from NotValid to StringFormat[NotValid] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  17. def getCause(): Throwable
    Definition Classes
    Throwable
  18. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. def getLocalizedMessage(): String
    Definition Classes
    Throwable
  20. def getMessage(): String
    Definition Classes
    NotValid → Throwable
  21. def getStackTrace(): Array[StackTraceElement]
    Definition Classes
    Throwable
  22. final def getSuppressed(): Array[Throwable]
    Definition Classes
    Throwable
  23. def initCause(arg0: Throwable): Throwable
    Definition Classes
    Throwable
  24. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  25. val item: RequestItem
  26. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  28. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  29. def printStackTrace(arg0: PrintWriter): Unit
    Definition Classes
    Throwable
  30. def printStackTrace(arg0: PrintStream): Unit
    Definition Classes
    Throwable
  31. def printStackTrace(): Unit
    Definition Classes
    Throwable
  32. val rule: String
  33. def setStackTrace(arg0: Array[StackTraceElement]): Unit
    Definition Classes
    Throwable
  34. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  35. def toString(): String
    Definition Classes
    Throwable → AnyRef → Any
  36. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  38. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  39. def →[B](y: B): (NotValid, B)
    Implicit
    This member is added by an implicit conversion from NotValid to ArrowAssoc[NotValid] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Deprecated Value Members

  1. def getStackTraceString: String
    Implicit
    This member is added by an implicit conversion from NotValid to RichException performed by method RichException in scala.Predef.
    Definition Classes
    RichException
    Annotations
    @deprecated
    Deprecated

    (Since version 2.11.0) use Throwable#getStackTrace

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Error

Inherited from NoStackTrace

Inherited from Exception

Inherited from Throwable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion RichException from NotValid to RichException

Inherited by implicit conversion any2stringadd from NotValid to any2stringadd[NotValid]

Inherited by implicit conversion StringFormat from NotValid to StringFormat[NotValid]

Inherited by implicit conversion Ensuring from NotValid to Ensuring[NotValid]

Inherited by implicit conversion ArrowAssoc from NotValid to ArrowAssoc[NotValid]

Ungrouped