Packages

package root

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.

Definition Classes: io

package argonaut

Definition Classes: finch

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.

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

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.

Definition Classes: finch

package test

Definition Classes: finch

package todo

Definition Classes: finch

package wrk

Definition Classes: finch

Application

Audio

Bootstrap

Decode

DecodeEntity

DecodePath

Encode

Endpoint

EndpointResult

Endpoints

Error

Errors

HighPriorityDecode

HighPriorityEncodeInstances

HighPriorityToResponseInstances

Image

Input

IterateeInstances

LowPriorityDecode

LowPriorityEncodeInstances

LowPriorityInstances

LowPriorityToResponseInstances

Output

Outputs

Text

ToResponse

ToService

Trace

ValidationRule

ValidationRules

items

root

io.finch

ValidationRule

Companion trait ValidationRule

object ValidationRule

Allows the creation of reusable validation rules for Endpoints.

Source: ValidationRule.scala

Linear Supertypes

AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

ValidationRule
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Value Members

final def !=(arg0: Any): Boolean

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

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

Definition Classes
AnyRef → Any
def apply[A](desc: String)(p: (A) ⇒ Boolean): ValidationRule[A]
Creates a new reusable ValidationRule based on the specified predicate.
Creates a new reusable ValidationRule based on the specified predicate.
desc
text describing the rule being validated
p
returns true if the data is valid
returns
a new reusable validation rule.
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

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

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

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

Definition Classes
AnyRef → Any
Annotations
@native()
def hashCode(): Int

Definition Classes
AnyRef → Any
Annotations
@native()
final def isInstanceOf[T0]: Boolean

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
Annotations
@native()
final def notifyAll(): Unit

Definition Classes
AnyRef
Annotations
@native()
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
implicit def toOptionalRule[A](rule: ValidationRule[A]): ValidationRule[Option[A]]
Implicit conversion that allows the same ValidationRule to be used for required and optional values.
Implicit conversion that allows the same ValidationRule to be used for required and optional values. If the optional value is non-empty, it gets validated (and validation may fail, producing an error), but if it is empty, it is always treated as valid.
rule
the validation rule to adapt for optional values
returns
a new validation rule that applies the specified rule to an optional value in case it is not empty
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@native() @throws( ... )

Packages

ValidationRule

Companion trait ValidationRule

object ValidationRule

Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

ValidationRule 

Companion trait ValidationRule

object ValidationRule

Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

ValidationRule