Trait/Object

io.finch

EndpointModule

Related Docs: object EndpointModule | package finch

Permalink

trait EndpointModule[F[_]] extends AnyRef

Enables users to construct Endpoint instances without specifying the effect type F[_] every time.

For example, via extending the Endpoint.Module[F[_]]:

import io.finch._
import io.cats.effect.IO

object Main extends App with Endpoint.Module[IO] {
  def foo = path("foo")
}

It's also possible to instantiate an EndpointModule for a given effect and import its symbols into the score. For example:

import io.finch._
import io.cats.effect.IO

object Main extends App {
  val io = Endpoint[IO]
  import io._

  def foo = path("foo")
}

There is a pre-defined EndpointModule for Cats' IO, available via the import:

import io.finch._
import io.finch.catsEffect._

object Main extends App {
  def foo = path("foo")
}
Linear Supertypes
AnyRef, Any
Known Subclasses
catsEffect
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. EndpointModule
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

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 binaryBody(implicit F: Sync[F]): Endpoint[F, Array[Byte]]

    Permalink

    An alias for Endpoint.binaryBody.

  6. def binaryBodyOption(implicit F: Sync[F]): Endpoint[F, Option[Array[Byte]]]

    Permalink

    An alias for Endpoint.binaryBodyOption.

  7. def binaryBodyStream[S[_[_], _]](implicit F: Sync[F], LR: LiftReader[S, F]): Endpoint[F, S[F, Array[Byte]]]

    Permalink

    An alias for Endpoint.binaryBodyStream.

  8. def body[A, CT](implicit arg0: ClassTag[A], D: Dispatchable[A, CT], F: Sync[F]): Endpoint[F, A]

    Permalink

    An alias for Endpoint.body.

  9. def bodyOption[A, CT](implicit arg0: ClassTag[A], F: Sync[F], D: Dispatchable[A, CT]): Endpoint[F, Option[A]]

    Permalink

    An alias for Endpoint.bodyOption.

  10. def bodyStream[S[_[_], _], A, CT <: String](implicit F: Sync[F], LR: LiftReader[S, F], A: Aux[S, F, A, CT]): Endpoint[F, S[F, A]]

    Permalink

    An alias for Endpoint.bodyStream.

  11. def classpathAsset(path: String)(implicit F: Sync[F], S: ContextShift[F]): Endpoint[F, Buf]

    Permalink

    An alias for Endpoint.classpathAsset.

  12. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  13. def const[A](a: A)(implicit F: Applicative[F]): Endpoint[F, A]

    Permalink

    An alias for Endpoint.const.

  14. def cookie(name: String)(implicit F: Sync[F]): Endpoint[F, Cookie]

    Permalink

    An alias for Endpoint.cookie.

  15. def cookieOption(name: String)(implicit F: Sync[F]): Endpoint[F, Option[Cookie]]

    Permalink

    An alias for Endpoint.cookieOption.

  16. def delete[A](e: Endpoint[F, A]): Mappable[F, A]

    Permalink

    An alias for Endpoint.delete.

  17. def empty[A]: Endpoint[F, A]

    Permalink

    An alias for Endpoint.empty.

  18. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  19. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  20. def filesystemAsset(path: String)(implicit F: Sync[F], S: ContextShift[F]): Endpoint[F, Buf]

    Permalink

    An alias for Endpoint.classpathAsset.

  21. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  22. def fromFile(file: File)(implicit F: Sync[F], S: ContextShift[F]): Endpoint[F, Buf]

    Permalink

    An alias for Endpoint.fromFile.

  23. def fromInputStream(stream: Resource[F, InputStream])(implicit F: Sync[F], S: ContextShift[F]): Endpoint[F, Buf]

    Permalink

    An alias for Endpoint.fromInputStream.

  24. def get[A](e: Endpoint[F, A]): Mappable[F, A]

    Permalink

    An alias for Endpoint.get.

  25. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  26. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  27. def head[A](e: Endpoint[F, A]): Mappable[F, A]

    Permalink

    An alias for Endpoint.head.

  28. def header[A](name: String)(implicit arg0: DecodeEntity[A], arg1: ClassTag[A], F: Sync[F]): Endpoint[F, A]

    Permalink

    An alias for Endpoint.header.

  29. def headerOption[A](name: String)(implicit arg0: DecodeEntity[A], arg1: ClassTag[A], F: Sync[F]): Endpoint[F, Option[A]]

    Permalink

    An alias for Endpoint.headerOption.

  30. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  31. def jsonBody[A](implicit arg0: Json[A], arg1: ClassTag[A], F: Sync[F]): Endpoint[F, A]

    Permalink

    An alias for Endpoint.jsonBody.

  32. def jsonBodyOption[A](implicit arg0: Json[A], arg1: ClassTag[A], F: Sync[F]): Endpoint[F, Option[A]]

    Permalink

    An alias for Endpoint.jsonBodyOption.

  33. def jsonBodyStream[S[_[_], _], A](implicit F: Sync[F], LR: LiftReader[S, F], A: Aux[S, F, A, Json]): Endpoint[F, S[F, A]]

    Permalink

    An alias for Endpoint.jsonBodyStream.

  34. def lift[A](a: ⇒ A)(implicit F: Sync[F]): Endpoint[F, A]

    Permalink

    An alias for Endpoint.lift().

  35. def liftAsync[A](fa: ⇒ F[A])(implicit F: Sync[F]): Endpoint[F, A]

    Permalink

    An alias for Endpoint.liftAsync.

  36. def liftOutput[A](oa: ⇒ Output[A])(implicit F: Sync[F]): Endpoint[F, A]

    Permalink

    An alias for Endpoint.liftOutput.

  37. def liftOutputAsync[A](foa: ⇒ F[Output[A]])(implicit F: Sync[F]): Endpoint[F, A]

    Permalink

    An alias for Endpoint.liftOutputAsync.

  38. def multipartAttribute[A](name: String)(implicit arg0: DecodeEntity[A], arg1: ClassTag[A], F: Sync[F]): Endpoint[F, A]

    Permalink

    An alias for Endpoint.multipartAttribute.

  39. def multipartAttributeOption[A](name: String)(implicit arg0: DecodeEntity[A], arg1: ClassTag[A], F: Sync[F]): Endpoint[F, Option[A]]

    Permalink

    An alias for Endpoint.multipartAttributeOption.

  40. def multipartAttributes[A](name: String)(implicit arg0: DecodeEntity[A], arg1: ClassTag[A], F: Sync[F]): Endpoint[F, List[A]]

    Permalink

    An alias for Endpoint.multipartAttributes.

  41. def multipartAttributesNel[A](name: String)(implicit arg0: DecodeEntity[A], arg1: ClassTag[A], F: Sync[F]): Endpoint[F, NonEmptyList[A]]

    Permalink

    An alias for Endpoint.multipartAttributesNel.

  42. def multipartFileUpload(name: String)(implicit F: Sync[F]): Endpoint[F, FileUpload]

    Permalink

    An alias for Endpoint.multipartFileUpload.

  43. def multipartFileUploadOption(name: String)(implicit F: Sync[F]): Endpoint[F, Option[FileUpload]]

    Permalink

    An alias for Endpoint.multipartFileUploadOption.

  44. def multipartFileUploads(name: String)(implicit F: Sync[F]): Endpoint[F, List[FileUpload]]

    Permalink

    An alias for Endpoint.multipartFileUploads.

  45. def multipartFileUploadsNel(name: String)(implicit F: Sync[F]): Endpoint[F, NonEmptyList[FileUpload]]

    Permalink

    An alias for Endpoint.multipartFileUploadsNel.

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

    Permalink
    Definition Classes
    AnyRef

  47. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  48. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  49. def options[A](e: Endpoint[F, A]): Mappable[F, A]

    Permalink

    An alias for Endpoint.options.

  50. def param[A](name: String)(implicit arg0: DecodeEntity[A], arg1: ClassTag[A], F: Sync[F]): Endpoint[F, A]

    Permalink

    An alias for Endpoint.param.

  51. def paramOption[A](name: String)(implicit arg0: DecodeEntity[A], arg1: ClassTag[A], F: Sync[F]): Endpoint[F, Option[A]]

    Permalink

    An alias for Endpoint.paramOption.

  52. def params[A](name: String)(implicit arg0: DecodeEntity[A], arg1: ClassTag[A], F: Sync[F]): Endpoint[F, List[A]]

    Permalink

    An alias for Endpoint.params.

  53. def paramsNel[A](name: String)(implicit arg0: DecodeEntity[A], arg1: ClassTag[A], F: Sync[F]): Endpoint[F, NonEmptyList[A]]

    Permalink

    An alias for Endpoint.paramsNel.

  54. def patch[A](e: Endpoint[F, A]): Mappable[F, A]

    Permalink

    An alias for Endpoint.patch.

  55. implicit def path(s: String)(implicit F: Sync[F]): Endpoint[F, HNil]

    Permalink

    An alias for Endpoint.path.

    An alias for Endpoint.path.

    Note

    This method is implicit such that an implicit conversion String => Endpoint[F, HNil] works.

  56. def path[A](implicit arg0: DecodePath[A], arg1: ClassTag[A], F: Sync[F]): Endpoint[F, A]

    Permalink

    An alias for Endpoint.path.

  57. def pathAny(implicit F: Applicative[F]): Endpoint[F, HNil]

    Permalink

    An alias for Endpoint.pathAny.

  58. def pathEmpty(implicit F: Applicative[F]): Endpoint[F, HNil]

    Permalink

    An alias for Endpoint.pathEmpty.

  59. def paths[A](implicit arg0: DecodePath[A], arg1: ClassTag[A], F: Sync[F]): Endpoint[F, List[A]]

    Permalink

    An alias for Endpoint.paths.

  60. def post[A](e: Endpoint[F, A]): Mappable[F, A]

    Permalink

    An alias for Endpoint.post.

  61. def put[A](e: Endpoint[F, A]): Mappable[F, A]

    Permalink

    An alias for Endpoint.put.

  62. def root(implicit F: Sync[F]): Endpoint[F, Request]

    Permalink

    An alias for Endpoint.root.

  63. def stringBody(implicit F: Sync[F]): Endpoint[F, String]

    Permalink

    An alias for Endpoint.stringBody.

  64. def stringBodyOption(implicit F: Sync[F]): Endpoint[F, Option[String]]

    Permalink

    An alias for Endpoint.stringBodyOption.

  65. def stringBodyStream[S[_[_], _]](implicit F: Sync[F], LR: LiftReader[S, F]): Endpoint[F, S[F, String]]

    Permalink

    An alias for Endpoint.stringBodyStream.

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

    Permalink
    Definition Classes
    AnyRef

  67. def textBody[A](implicit arg0: Text[A], arg1: ClassTag[A], F: Sync[F]): Endpoint[F, A]

    Permalink

    An alias for Endpoint.textBody.

  68. def textBodyOption[A](implicit arg0: Text[A], arg1: ClassTag[A], F: Sync[F]): Endpoint[F, Option[A]]

    Permalink

    An alias for Endpoint.textBodyOption.

  69. def textBodyStream[S[_[_], _], A](implicit F: Sync[F], LR: LiftReader[S, F], A: Aux[S, F, A, Plain]): Endpoint[F, S[F, A]]

    Permalink

    An alias for Endpoint.textBodyStream.

  70. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  71. def trace[A](e: Endpoint[F, A]): Mappable[F, A]

    Permalink

    An alias for Endpoint.trace.

  72. final def wait(): Unit

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

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

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

  74. final def wait(arg0: Long): Unit

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

  75. def zero(implicit F: Applicative[F]): Endpoint[F, HNil]

    Permalink

    An alias for Endpoint.zero.

Inherited from AnyRef

Inherited from Any

Ungrouped