Packages

trait Urls extends algebra.Urls

algebra.Urls interpreter that builds URLs.

Source
Urls.scala
Linear Supertypes
algebra.Urls, endpoints4s.PartialInvariantFunctorSyntax, endpoints4s.InvariantFunctorSyntax, AnyRef, Any
Known Subclasses
ChunkedEntities, ChunkedJsonEntities, Endpoints, EndpointsWithCustomErrors, JsonEntitiesFromCodecs, JsonEntitiesFromSchemas
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Urls
  2. Urls
  3. PartialInvariantFunctorSyntax
  4. InvariantFunctorSyntax
  5. AnyRef
  6. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. implicit class InvariantFunctorSyntax[A, F[_]] extends AnyRef
    Definition Classes
    InvariantFunctorSyntax
  2. implicit class PartialInvariantFunctorSyntax[A, F[_]] extends AnyRef
    Definition Classes
    PartialInvariantFunctorSyntax
  3. trait Path[A] extends Url[A]
  4. implicit class PathOps[A] extends AnyRef
    Definition Classes
    Urls
  5. trait QueryString[A] extends AnyRef
  6. type QueryStringParam[A] = (A) => List[String]

    a query string parameter can have zero or several values

    a query string parameter can have zero or several values

    Definition Classes
    Urls → Urls
  7. implicit class QueryStringSyntax[A] extends AnyRef
    Definition Classes
    Urls
  8. trait Segment[A] extends AnyRef
  9. trait Url[A] extends AnyRef
  10. type WithDefault[A] = Option[A]
    Definition Classes
    Urls → Urls

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from Urls toany2stringadd[Urls] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Urls, B)
    Implicit
    This member is added by an implicit conversion from Urls toArrowAssoc[Urls] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. implicit def booleanQueryString: QueryStringParam[Boolean]
    Definition Classes
    Urls
  8. def chainPaths[A, B](first: Path[A], second: Path[B])(implicit tupler: Tupler[A, B]): Path[Out]
    Definition Classes
    Urls → Urls
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  10. def combineQueryStrings[A, B](first: QueryString[A], second: QueryString[B])(implicit tupler: Tupler[A, B]): QueryString[Out]
    Definition Classes
    Urls → Urls
  11. implicit def doubleQueryString: QueryStringParam[Double]
    Definition Classes
    Urls
  12. implicit def doubleSegment: Segment[Double]
    Definition Classes
    Urls
  13. def ensuring(cond: (Urls) => Boolean, msg: => Any): Urls
    Implicit
    This member is added by an implicit conversion from Urls toEnsuring[Urls] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: (Urls) => Boolean): Urls
    Implicit
    This member is added by an implicit conversion from Urls toEnsuring[Urls] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean, msg: => Any): Urls
    Implicit
    This member is added by an implicit conversion from Urls toEnsuring[Urls] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: Boolean): Urls
    Implicit
    This member is added by an implicit conversion from Urls toEnsuring[Urls] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  19. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. implicit def intQueryString: QueryStringParam[Int]
    Definition Classes
    Urls
  22. implicit def intSegment: Segment[Int]
    Definition Classes
    Urls
  23. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  24. implicit def longQueryString: QueryStringParam[Long]
    Definition Classes
    Urls
  25. implicit def longSegment: Segment[Long]
    Definition Classes
    Urls
  26. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  28. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  29. def optQsWithDefault[A](name: String, default: A, docs: Documentation = None)(implicit value: QueryStringParam[A]): QueryString[WithDefault[A]]
    Definition Classes
    Urls → Urls
  30. implicit def optionalQueryStringParam[A](implicit param: QueryStringParam[A]): QueryStringParam[Option[A]]
    Definition Classes
    Urls → Urls
  31. val path: Path[Unit]
    Definition Classes
    Urls
  32. implicit lazy val pathPartialInvariantFunctor: PartialInvariantFunctor[Path]
    Definition Classes
    Urls → Urls
  33. def qs[A](name: String, docs: Documentation)(implicit param: QueryStringParam[A]): QueryString[A]
    Definition Classes
    Urls → Urls
  34. implicit lazy val queryStringParamPartialInvariantFunctor: PartialInvariantFunctor[QueryStringParam]
    Definition Classes
    Urls → Urls
  35. implicit lazy val queryStringPartialInvariantFunctor: PartialInvariantFunctor[QueryString]
    Definition Classes
    Urls → Urls
  36. def remainingSegments(name: String, docs: Documentation): Path[String]
    Definition Classes
    Urls → Urls
  37. implicit def repeatedQueryStringParam[A, CC[X] <: Iterable[X]](implicit param: QueryStringParam[A], factory: Factory[A, CC[A]]): QueryStringParam[CC[A]]
    Definition Classes
    Urls → Urls
  38. def segment[A](name: String, docs: Documentation)(implicit s: Segment[A]): Path[A]
    Definition Classes
    Urls → Urls
  39. implicit lazy val segmentPartialInvariantFunctor: PartialInvariantFunctor[Segment]
    Definition Classes
    Urls → Urls
  40. def staticPathSegment(segment: String): Path[Unit]
    Definition Classes
    Urls → Urls
  41. implicit lazy val stringQueryString: QueryStringParam[String]
    Definition Classes
    Urls → Urls
  42. implicit lazy val stringSegment: Segment[String]
    Definition Classes
    Urls → Urls
  43. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  44. def toString(): String
    Definition Classes
    AnyRef → Any
  45. implicit lazy val urlPartialInvariantFunctor: PartialInvariantFunctor[Url]
    Definition Classes
    Urls → Urls
  46. def urlWithQueryString[A, B](path: Path[A], qs: QueryString[B])(implicit tupler: Tupler[A, B]): Url[Out]
    Definition Classes
    Urls → Urls
  47. val utf8Name: String
  48. implicit def uuidQueryString: QueryStringParam[UUID]
    Definition Classes
    Urls
  49. implicit def uuidSegment: Segment[UUID]
    Definition Classes
    Urls
  50. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  51. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  52. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated
  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Urls toStringFormat[Urls] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def →[B](y: B): (Urls, B)
    Implicit
    This member is added by an implicit conversion from Urls toArrowAssoc[Urls] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from algebra.Urls

Inherited from endpoints4s.PartialInvariantFunctorSyntax

Inherited from endpoints4s.InvariantFunctorSyntax

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromUrls to any2stringadd[Urls]

Inherited by implicit conversion StringFormat fromUrls to StringFormat[Urls]

Inherited by implicit conversion Ensuring fromUrls to Ensuring[Urls]

Inherited by implicit conversion ArrowAssoc fromUrls to ArrowAssoc[Urls]

Ungrouped