Packages

  • package root
    Definition Classes
    root
  • package endpoints4s

    • algebras are in the algebra package,
    • interpreters are in the other packages (e.g., pekkohttp, http4s, openapi, etc.),
    • Types defined in this package are utility classes (e.g., Validated, Tupler).
    Definition Classes
    root
  • package algebra

    Algebra interfaces

    Algebra interfaces

    Definition Classes
    endpoints4s
  • trait Urls extends PartialInvariantFunctorSyntax

    Algebra interface for describing URLs made of a path and a query string.

    Algebra interface for describing URLs made of a path and a query string.

    A path is itself made of segments chained together.

    A query string is made of named parameters.

    /**
  * Describes an URL starting with a segment containing “articles”, followed
  * by another `String` segment, and a query string containing
  * a mandatory `Lang` parameter named “lang”, and an
  * optional `Int` parameter named “page”.
  *
  * Examples of matching URLs:
  *
  * - /articles/kitchen?lang=fr
  * - /articles/garden?lang=en&page=2
  */
val example = path / "articles" / segment[String]() /? (qs[Lang]("lang") & qs[Option[Int]]("page"))
    Definition Classes
    algebra
  • InvariantFunctorSyntax
  • PartialInvariantFunctorSyntax
  • Path
  • PathOps
  • QueryString
  • QueryStringParam
  • QueryStringSyntax
  • Segment
  • Url
  • WithDefault

implicit class PathOps[A] extends AnyRef

Convenient methods for Paths.

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

Instance Constructors

  1. new PathOps(first: Path[A])

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def /[B](second: Path[B])(implicit tupler: Tupler[A, B]): Path[Out]

    Chains this path with the second path segment

  4. final def /(second: String): Path[A]

    Chains this path with the second constant path segment

  5. final def /?[B](qs: QueryString[B])(implicit tupler: Tupler[A, B]): Url[Out]

    Chains this path with the given QueryString

  6. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  11. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  18. def toString(): String
    Definition Classes
    AnyRef → Any
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped