Object/Trait

io.finch

Endpoint

Related Docs: trait Endpoint | package finch

Permalink

object Endpoint

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

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Endpoint
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. implicit final class HListEndpointOps[L <: HList] extends AnyVal

    Permalink
  2. implicit final class OptionEndpointOps[A] extends AnyVal

    Permalink

    Implicit conversion that adds convenience methods to endpoint for optional values.

  3. type Result[A] = EndpointResult[A]

    Permalink
  4. implicit final class StringEndpointOps extends AnyVal

    Permalink

    Implicit conversion that allows to call as[A] on any Endpoint[String] to perform a type conversion based on an implicit DecodeEntity[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 DecodeEntity[A] which must be in scope.

    The resulting endpoint will fail when type conversion fails.

  5. implicit final class StringNelEndpointOps extends AnyVal

    Permalink

    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.

  6. implicit final class StringOptionEndpointOps extends AnyVal

    Permalink

    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.

  7. implicit final class StringSeqEndpointOps extends AnyVal

    Permalink

    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.

  8. implicit final class ValueEndpointOps[B] extends AnyVal

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. def const[A](a: A): Endpoint[A]

    Permalink

    Creates an Endpoint that always matches and returns a given value (evaluated eagerly).

  7. def empty[A]: Endpoint[A]

    Permalink

    Creates an empty Endpoint (an endpoint that never matches) for a given type.

  8. implicit val endpointInstance: Alternative[Endpoint]

    Permalink
  9. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  11. def finalize(): Unit

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

    Permalink
    Definition Classes
    AnyRef → Any
  13. def hashCode(): Int

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

    Permalink
    Definition Classes
    Any
  15. def lift[A](a: ⇒ A): Endpoint[A]

    Permalink

    Creates an Endpoint that always matches and returns a given value (evaluated lazily).

    Creates an Endpoint that always matches and returns a given value (evaluated lazily).

    This might be useful for wrapping functions returning arbitrary value within Endpoint context.

    Example: the following endpoint will recompute a random integer on each request.

    val nextInt: Endpoint[Int] = Endpoint.lift(scala.util.random.nextInt)
  16. def liftFuture[A](fa: ⇒ Future[A]): Endpoint[A]

    Permalink

    Creates an Endpoint that always matches and returns a given Future (evaluated lazily).

  17. def liftFutureOutput[A](foa: ⇒ Future[Output[A]]): Endpoint[A]

    Permalink

    Creates an Endpoint that always matches and returns a given Future[Output] (evaluated lazily).

  18. def liftOutput[A](oa: ⇒ Output[A]): Endpoint[A]

    Permalink

    Creates an Endpoint that always matches and returns a given Output (evaluated lazily).

  19. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  20. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  21. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  22. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  23. def toString(): String

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

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

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

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

Inherited from AnyRef

Inherited from Any

Ungrouped