Mappable

Abstract Value Members

abstract def apply(input: Input): Result[F, A]

Runs this endpoint.
Runs this endpoint.

Definition Classes
Endpoint

Concrete Value Members

final def !=(arg0: Any): Boolean

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

Definition Classes
AnyRef → Any
final def :+:[B](that: Endpoint[F, B])(implicit a: Adjoin[:+:[B, :+:[A, CNil]]], F: MonadError[F, Throwable]): Endpoint[F, shapeless.ops.adjoin.Adjoin.Out]

Composes this endpoint with another in such a way that coproducts are flattened.
Composes this endpoint with another in such a way that coproducts are flattened.

Definition Classes
Endpoint
final def ::[B](other: Endpoint[F, B])(implicit pa: PairAdjoin[B, A], F: MonadError[F, Throwable]): Endpoint[F, internal.PairAdjoin.Out]

Composes this endpoint with the given Endpoint.
Composes this endpoint with the given Endpoint.

Definition Classes
Endpoint
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def apply(mapper: Mapper[F, A]): Endpoint[F, Out]
final def asInstanceOf[T0]: T0

Definition Classes
Any
final def attempt(implicit F: MonadError[F, Throwable]): Endpoint[F, Either[Throwable, A]]

Lifts this endpoint into one that always succeeds, with A representing both success and failure cases.
Lifts this endpoint into one that always succeeds, with A representing both success and failure cases.

Definition Classes
Endpoint
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def compile(implicit F: MonadError[F, Throwable], tr: ToResponse.Aux[F, A, Json], tre: ToResponse.Aux[F, Exception, Json]): Compiled[F]

Converts this endpoint to Endpoint.Compiled[F] what is efficiently is Kleisli[F, Request, Response] where responses are encoded with JSON encoder.
Converts this endpoint to Endpoint.Compiled[F] what is efficiently is Kleisli[F, Request, Response] where responses are encoded with JSON encoder.
Consider using io.finch.Bootstrap instead

Definition Classes
Endpoint
final def compileAs[CT <: String](implicit F: MonadError[F, Throwable], tr: ToResponse.Aux[F, A, CT], tre: ToResponse.Aux[F, Exception, CT]): Compiled[F]

Converts this endpoint to Endpoint.Compiled[F] what is efficiently is Kleisli[F, Request, Response] where responses are encoded with encoder corresponding to CT Content-Type.
Converts this endpoint to Endpoint.Compiled[F] what is efficiently is Kleisli[F, Request, Response] where responses are encoded with encoder corresponding to CT Content-Type.
Consider using io.finch.Bootstrap instead

Definition Classes
Endpoint
final def coproduct[B >: A](other: Endpoint[F, B]): Endpoint[F, B]

Sequentially composes this endpoint with the given other endpoint.
Sequentially composes this endpoint with the given other endpoint. The resulting endpoint will succeed if either this or that endpoints are succeed.
Matching Rules
- if both endpoints match, the result with a shorter remainder (in terms of consumed route) is picked - if both endpoints don't match, the more specific result (explaining the reason for not matching) is picked

Definition Classes
Endpoint
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
final def handle(pf: PartialFunction[Throwable, Output[A]])(implicit F: ApplicativeError[F, Throwable]): Endpoint[F, A]

Recovers from any exception occurred in this endpoint by creating a new endpoint that will handle any matching throwable from the underlying future.
Recovers from any exception occurred in this endpoint by creating a new endpoint that will handle any matching throwable from the underlying future.

Definition Classes
Endpoint
def hashCode(): Int

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

Definition Classes
Any
def item: RequestItem

Request item (part) that's this endpoint work with.
Request item (part) that's this endpoint work with.

Definition Classes
Endpoint
final def map[B](fn: (A) ⇒ B)(implicit F: Monad[F]): Endpoint[F, B]

Maps this endpoint to the given function A => B.
Maps this endpoint to the given function A => B.

Definition Classes
Endpoint
final def mapAsync[B](fn: (A) ⇒ F[B])(implicit F: Monad[F]): Endpoint[F, B]

Maps this endpoint to the given function A => Future[B].
Maps this endpoint to the given function A => Future[B].

Definition Classes
Endpoint
final def mapOutput[B](fn: (A) ⇒ Output[B])(implicit F: MonadError[F, Throwable]): Endpoint[F, B]

Maps this endpoint to the given function A => Output[B].
Maps this endpoint to the given function A => Output[B].

Definition Classes
Endpoint
final def mapOutputAsync[B](fn: (A) ⇒ F[Output[B]])(implicit F: Monad[F]): Endpoint[F, B]

Maps this endpoint to the given function A => Future[Output[B]].
Maps this endpoint to the given function A => Future[Output[B]].

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def product[B](other: Endpoint[F, B])(implicit F: MonadError[F, Throwable]): Endpoint[F, (A, B)]

Returns a product of this and other endpoint.
Returns a product of this and other endpoint. The resulting endpoint returns a tuple of both values.
This combinator is an important piece for Finch's error accumulation. In its current form, product will accumulate Finch's own errors (i.e., io.finch.Errors) into io.finch.Errors) and will fail-fast with the first non-Finch error (just ordinary Exception) observed.

Definition Classes
Endpoint
final def productWith[B, O](other: Endpoint[F, B])(p: (A, B) ⇒ O)(implicit F: MonadError[F, Throwable]): Endpoint[F, O]

Returns a product of this and other endpoint.
Returns a product of this and other endpoint. The resulting endpoint returns a value of resulting type for product function.

Definition Classes
Endpoint
final def rescue(pf: PartialFunction[Throwable, F[Output[A]]])(implicit F: ApplicativeError[F, Throwable]): Endpoint[F, A]

Recovers from any exception occurred in this endpoint by creating a new endpoint that will handle any matching throwable from the underlying future.
Recovers from any exception occurred in this endpoint by creating a new endpoint that will handle any matching throwable from the underlying future.

Definition Classes
Endpoint
final def should(rule: ValidationRule[A])(implicit F: MonadError[F, Throwable]): Endpoint[F, A]

Validates the result of this endpoint using a predefined rule.
Validates the result of this endpoint using a predefined rule. This method allows for rules to be reused across multiple endpoints.
rule
the predefined ValidationRule that will return true if the data is valid
returns
an endpoint that will return the value of this reader if it is valid. Otherwise the future fails with an Error.NotValid error.

Definition Classes
Endpoint
final def should(rule: String)(predicate: (A) ⇒ Boolean)(implicit F: MonadError[F, Throwable]): Endpoint[F, A]

Validates the result of this endpoint using a predicate.
Validates the result of this endpoint using a predicate. The rule is used for error reporting.
rule
text describing the rule being validated
predicate
returns true if the data is valid
returns
an endpoint that will return the value of this reader if it is valid. Otherwise the future fails with an Error.NotValid error.

Definition Classes
Endpoint
final def shouldNot(rule: ValidationRule[A])(implicit F: MonadError[F, Throwable]): Endpoint[F, A]

Validates the result of this endpoint using a predefined rule.
Validates the result of this endpoint using a predefined rule. This method allows for rules to be reused across multiple endpoints.
rule
the predefined ValidationRule that will return false if the data is valid
returns
an endpoint that will return the value of this reader if it is valid. Otherwise the future fails with a Error.NotValid error.

Definition Classes
Endpoint
final def shouldNot(rule: String)(predicate: (A) ⇒ Boolean)(implicit F: MonadError[F, Throwable]): Endpoint[F, A]

Validates the result of this endpoint using a predicate.
Validates the result of this endpoint using a predicate. The rule is used for error reporting.
rule
text describing the rule being validated
predicate
returns false if the data is valid
returns
an endpoint that will return the value of this reader if it is valid. Otherwise the future fails with a Error.NotValid error.

Definition Classes
Endpoint
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
final def toService(implicit F: Effect[F], tr: ToResponse.Aux[F, A, Json], tre: ToResponse.Aux[F, Exception, Json]): Service[Request, Response]

Converts this endpoint to a Finagle service Request => Future[Response] that serves JSON.
Converts this endpoint to a Finagle service Request => Future[Response] that serves JSON.
Consider using io.finch.Bootstrap instead.

Definition Classes
Endpoint
final def toServiceAs[CT <: String](implicit F: Effect[F], tr: ToResponse.Aux[F, A, CT], tre: ToResponse.Aux[F, Exception, CT]): Service[Request, Response]

Converts this endpoint to a Finagle service Request => Future[Response] that serves custom content-type CT.
Converts this endpoint to a Finagle service Request => Future[Response] that serves custom content-type CT.
Consider using io.finch.Bootstrap instead.

Definition Classes
Endpoint
def toString(): String

Definition Classes
AnyRef → Any
final def transform[B](fn: (F[A]) ⇒ F[B])(implicit F: Monad[F]): Endpoint[F, B]

Transform this endpoint to the given function F[A] => F[B]
Transform this endpoint to the given function F[A] => F[B]

Definition Classes
Endpoint
final def transformOutput[B](fn: (F[Output[A]]) ⇒ F[Output[B]]): Endpoint[F, B]

Transforms this endpoint to the given function F[Output[A]] => F[Output[B]].
Transforms this endpoint to the given function F[Output[A]] => F[Output[B]].
Might be useful to perform some extra action on the underlying Future. For example, time the latency of the given endpoint.
```
import io.finch._
import com.twitter.finagle.stats._

def time[A](stat: Stat, e: Endpoint[A]): Endpoint[A] =
  e.transform(f => Stat.timeFuture(s)(f))
```
Definition Classes
Endpoint
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
@throws( ... )
final def withToString(ts: ⇒ String): Endpoint[F, A]

Overrides the toString method on this endpoint.
Overrides the toString method on this endpoint.

Definition Classes
Endpoint

Deprecated Value Members

final def transformF[B](fn: (F[A]) ⇒ F[B])(implicit F: Monad[F]): Endpoint[F, B]

Transform this endpoint to the given function F[A] => F[B]
Transform this endpoint to the given function F[A] => F[B]

Definition Classes
Endpoint
Annotations
@deprecated
Deprecated
(Since version 0.29) Use .transform instead

Related Doc: package Endpoint

trait Mappable[F[_], A] extends Endpoint[F, A]

Abstract Value Members

abstract def apply(input: Input): Result[F, A]

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def :+:[B](that: Endpoint[F, B])(implicit a: Adjoin[:+:[B, :+:[A, CNil]]], F: MonadError[F, Throwable]): Endpoint[F, shapeless.ops.adjoin.Adjoin.Out]

final def ::[B](other: Endpoint[F, B])(implicit pa: PairAdjoin[B, A], F: MonadError[F, Throwable]): Endpoint[F, internal.PairAdjoin.Out]

final def ==(arg0: Any): Boolean

final def apply(mapper: Mapper[F, A]): Endpoint[F, Out]

final def asInstanceOf[T0]: T0

final def attempt(implicit F: MonadError[F, Throwable]): Endpoint[F, Either[Throwable, A]]

def clone(): AnyRef

final def compile(implicit F: MonadError[F, Throwable], tr: ToResponse.Aux[F, A, Json], tre: ToResponse.Aux[F, Exception, Json]): Compiled[F]

final def compileAs[CT <: String](implicit F: MonadError[F, Throwable], tr: ToResponse.Aux[F, A, CT], tre: ToResponse.Aux[F, Exception, CT]): Compiled[F]

final def coproduct[B >: A](other: Endpoint[F, B]): Endpoint[F, B]

Matching Rules

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

final def handle(pf: PartialFunction[Throwable, Output[A]])(implicit F: ApplicativeError[F, Throwable]): Endpoint[F, A]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def item: RequestItem

final def map[B](fn: (A) ⇒ B)(implicit F: Monad[F]): Endpoint[F, B]

final def mapAsync[B](fn: (A) ⇒ F[B])(implicit F: Monad[F]): Endpoint[F, B]

final def mapOutput[B](fn: (A) ⇒ Output[B])(implicit F: MonadError[F, Throwable]): Endpoint[F, B]

final def mapOutputAsync[B](fn: (A) ⇒ F[Output[B]])(implicit F: Monad[F]): Endpoint[F, B]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def product[B](other: Endpoint[F, B])(implicit F: MonadError[F, Throwable]): Endpoint[F, (A, B)]

final def productWith[B, O](other: Endpoint[F, B])(p: (A, B) ⇒ O)(implicit F: MonadError[F, Throwable]): Endpoint[F, O]

final def rescue(pf: PartialFunction[Throwable, F[Output[A]]])(implicit F: ApplicativeError[F, Throwable]): Endpoint[F, A]

final def should(rule: ValidationRule[A])(implicit F: MonadError[F, Throwable]): Endpoint[F, A]

final def should(rule: String)(predicate: (A) ⇒ Boolean)(implicit F: MonadError[F, Throwable]): Endpoint[F, A]

final def shouldNot(rule: ValidationRule[A])(implicit F: MonadError[F, Throwable]): Endpoint[F, A]

final def shouldNot(rule: String)(predicate: (A) ⇒ Boolean)(implicit F: MonadError[F, Throwable]): Endpoint[F, A]

final def synchronized[T0](arg0: ⇒ T0): T0

final def toService(implicit F: Effect[F], tr: ToResponse.Aux[F, A, Json], tre: ToResponse.Aux[F, Exception, Json]): Service[Request, Response]

final def toServiceAs[CT <: String](implicit F: Effect[F], tr: ToResponse.Aux[F, A, CT], tre: ToResponse.Aux[F, Exception, CT]): Service[Request, Response]

def toString(): String

final def transform[B](fn: (F[A]) ⇒ F[B])(implicit F: Monad[F]): Endpoint[F, B]

final def transformOutput[B](fn: (F[Output[A]]) ⇒ F[Output[B]]): Endpoint[F, B]

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

final def withToString(ts: ⇒ String): Endpoint[F, A]

Deprecated Value Members

final def transformF[B](fn: (F[A]) ⇒ F[B])(implicit F: Monad[F]): Endpoint[F, B]

Inherited from Endpoint[F, A]

Inherited from AnyRef

Inherited from Any

Ungrouped