Packages

p

endpoints4s

package endpoints4s

Source
package.scala
Linear Supertypes
Content Hierarchy
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. endpoints4s
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Package Members

  1. package algebra

    Algebra interfaces

  2. package circe

    Interpreters producing Circe codecs

  3. package fetch
  4. package generic

    Enriches algebras with operations performing generic derivation

  5. package http4s

    Interpreters producing http4s clients and servers

  6. package openapi

    Interpreters producing an OpenAPI model of endpoints

  7. package pekkohttp

    Interpreters producing Pekko-HTTP servers and clients

  8. package playjson

    Interpreters producing Play-JSON codecs

  9. package sttp

    Client interpreter using Sttp

  10. package ujson

    Interpreters producing JSON codecs using ujson

Type Members

  1. trait Codec[E, D] extends Decoder[E, D] with Encoder[D, E]

    A way to encode and decode values

    A way to encode and decode values

    E

    Type of encoded values

    D

    Type of decoded values

  2. trait Decoder[-From, +To] extends AnyRef

    A way to decode a From value into a To value.

  3. trait Encoder[-From, +To] extends AnyRef

    A way to encode a From value into a To value

  4. case class Invalid(errors: Seq[String]) extends Validated[Nothing] with Product with Serializable

    A list of validation errors

  5. trait InvariantFunctor[F[_]] extends AnyRef

    Defines ways to transform a given type constructor F

  6. trait InvariantFunctorSyntax extends AnyRef

    Provides extensions methods for values of type InvariantFunctor

  7. trait MultipleOf[A] extends AnyRef

    Type class that checks whether something is a multiple of another numeric value.

    Type class that checks whether something is a multiple of another numeric value. Added since the std-lib Numeric does not have a modulo function.

  8. final class NumericConstraints[A] extends Serializable

    Possible restrictions on the numeric value used.

    Possible restrictions on the numeric value used. Needs an instance for Ordering to check whether values are valid w.r.t. to the properties.

  9. trait PartialInvariantFunctor[F[_]] extends InvariantFunctor[F]

    Given a type constructor F, a partial function A => Validated[B] and a total function B => A, turns an F[A] into an F[B].

    Given a type constructor F, a partial function A => Validated[B] and a total function B => A, turns an F[A] into an F[B].

    A partial invariant functor is an invariant functor whose covariant transformation function is total (ie, A => Valid[B]).

  10. trait PartialInvariantFunctorSyntax extends InvariantFunctorSyntax

    Provides extension methods for values of type PartialInvariantFunctor

  11. trait Semigroupal[F[_]] extends AnyRef

    Ability for a type constructor F to combine together two values of type F[A] and F[B] into a value of type F[(A, B)]

  12. trait SemigroupalSyntax extends AnyRef

    Provides extension methods for values of type Semigroupal

  13. trait Tupler[A, B] extends AnyRef

    Defines a strategy for tupling A and B values, according to types A and B.

    Defines a strategy for tupling A and B values, according to types A and B.

    The actual implementation avoids nested tuples and eliminates Unit, so that instead of ending with, e.g., the following type:

    ((Unit, Int), (((Unit, Unit), String)))

    We just get:

    (Int, String)

    The following rules are implemented (by increasing priority):

    • A, B -> (A, B)
    • A, (B, C) -> (A, B, C)
    • (A, B), C -> (A, B, C)
    • A, (B, C, D) -> (A, B, C, D)
    • (A, B), (C, D) -> (A, B, C, D)
    • A, (B, C, D, E) -> (A, B, C, D, E)
    • (A, B), (C, D, E) -> (A, B, C, D, E)
    • (A, B, C), D -> (A, B, C, D)
    • (A, B, C, D), E -> (A, B, C, D, E)
    • (A, B, C, D, E), F -> (A, B, C, D, E, F)
    • A, Unit -> A
    • Unit, A -> A
  14. trait Tupler1 extends AnyRef
  15. trait Tupler2 extends Tupler1
  16. trait Tupler3 extends Tupler2
  17. trait Tupler4 extends TuplerAppend
  18. trait Tupler5 extends Tupler4
  19. trait TuplerAppend extends Tupler3

    Generated trait that provides Tupler instances for appending to tuples from 3 to 21 elements

  20. case class Valid[+A](value: A) extends Validated[A] with Product with Serializable

    A valid value of type A

  21. sealed trait Validated[+A] extends AnyRef

    A validated value of type A can either be Valid or Invalid

    A validated value of type A can either be Valid or Invalid

    A

    Type of the validated value

Value Members

  1. object Codec
  2. object Decoder
  3. object Encoder
  4. object Invalid extends Serializable
  5. object MultipleOf
  6. object NumericConstraints extends Serializable
  7. object Tupler extends Tupler5
  8. object Validated

Inherited from AnyRef

Inherited from Any

operations

Ungrouped