Object/Trait

Endpoint

Related Docs: trait Endpoint | package finch

Permalink

object Endpoint

Provides extension methods for Endpoint to support coproduct and path syntax.

Linear Supertypes

Ordering

Alphabetic
By Inheritance

Inherited

Endpoint
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Type Members

class GenericDerivation[A] extends AnyRef
implicit final class HListEndpointOps[L <: HList] extends AnyVal
implicit final class OptionEndpointOps[A] extends AnyVal

Implicit conversion that adds convenience methods to endpoint for optional values.
type Result[A] = Option[(Input, Rerunnable[Output[A]])]
implicit final class StringEndpointOps extends AnyVal

Implicit conversion that allows to call as[A] on any Endpoint[String] to perform a type conversion based on an implicit DecodeRequest[A] which must be in scope.
Implicit conversion that allows to call as[A] on any Endpoint[String] to perform a type conversion based on an implicit DecodeRequest[A] which must be in scope.
The resulting reader will fail when type conversion fails.
implicit class StringNelEndpointOps extends AnyRef

Implicit conversion that allows to call as[A] on any Endpoint[NonEmptyList[String]] to perform a type conversion based on an implicit Decode[A] which must be in scope.
Implicit conversion that allows to call as[A] on any Endpoint[NonEmptyList[String]] to perform a type conversion based on an implicit Decode[A] which must be in scope.
The resulting endpoint will fail when type conversion fails on one or more of the elements in the NonEmptyList. It will succeed if type conversion succeeds for all elements.
implicit final class StringOptionEndpointOps extends AnyVal

Implicit conversion that allows to call as[A] on any Endpoint[Option[String]] to perform a type conversion based on an implicit DecodeRequest[A] which must be in scope.
Implicit conversion that allows to call as[A] on any Endpoint[Option[String]] to perform a type conversion based on an implicit DecodeRequest[A] which must be in scope.
The resulting endpoint will fail when the result is non-empty and type conversion fails. It will succeed if the result is empty or type conversion succeeds.
implicit class StringSeqEndpointOps extends AnyRef

Implicit conversion that allows to call as[A] on any Endpoint[Seq[String]] to perform a type conversion based on an implicit DecodeRequest[A] which must be in scope.
Implicit conversion that allows to call as[A] on any Endpoint[Seq[String]] to perform a type conversion based on an implicit DecodeRequest[A] which must be in scope.
The resulting endpoint will fail when the result is non-empty and type conversion fails on one or more of the elements in the Seq. It will succeed if the result is empty or type conversion succeeds for all elements.
implicit final class ValueEndpointOps[B] extends AnyVal

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(mapper: Mapper[HNil]): Endpoint[Out]

Creates an Endpoint from the given Output.
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def derive[A]: GenericDerivation[A]

Generically derive a very basic instance of Endpoint for a given type A.
def empty[A]: Endpoint[A]

Creates an empty Endpoint (an endpoint that never matches) for a given type.
implicit val endpointInstance: Alternative[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
def hashCode(): Int

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

Definition Classes
Any
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 synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
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
@throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped