trait Urls extends PartialInvariantFunctorSyntax

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"))
Source
Urls.scala
Linear Supertypes
endpoints.PartialInvariantFunctorSyntax, endpoints.InvariantFunctorSyntax, AnyRef, Any
Known Subclasses
BasicAuthentication, ChunkedEntities, ChunkedJsonEntities, Endpoints, EndpointsWithCustomErrors, JsonEntitiesFromCodecs, JsonEntitiesFromSchemas, MuxEndpoints, Urls, BasicAuthentication, ChunkedEntities, ChunkedJsonEntities, Endpoints, EndpointsWithCustomErrors, JsonEntities, JsonEntitiesFromCodecs, JsonEntitiesFromEncodersAndDecoders, JsonEntitiesFromSchemas, MuxEndpoints, Urls, Assets, BasicAuthentication, ChunkedEntities, ChunkedJsonEntities, Endpoints, EndpointsWithCustomErrors, JsonCodecs, JsonEntities, JsonEntitiesFromCodecs, JsonEntitiesFromSchemas, LowLevelEndpoints, MuxEndpoints, Requests, JsonEntitiesFromCodecs, JsonEntitiesFromCodecs, BasicAuthentication, Endpoints, EndpointsWithCustomErrors, JsonEntitiesFromCodecs, JsonEntitiesFromSchemas, Urls, Assets, BasicAuthentication, ChunkedEntities, ChunkedJsonEntities, Endpoints, EndpointsWithCustomErrors, JsonEntities, JsonEntitiesFromSchemas, MuxEndpoints, Requests, Urls, BasicAuthentication, Endpoints, EndpointsWithCustomErrors, JsonEntitiesFromCodecs, MuxEndpoints, Urls, Assets, BasicAuthentication, ChunkedEntities, ChunkedJsonEntities, Endpoints, EndpointsWithCustomErrors, JsonEntitiesFromCodecs, JsonEntitiesFromEncodersAndDecoders, JsonEntitiesFromSchemas, LowLevelEndpoints, MuxEndpoints, Urls, JsonEntities, JsonEntitiesFromCodecs, BasicAuthentication, Endpoints, EndpointsWithCustomErrors, JsonEntitiesFromCodecs, Requests, Urls, BasicAuthentication, Endpoints, EndpointsWithCustomErrors, JsonEntitiesFromCodecs, MuxEndpoints, Urls, Assets, BasicAuthentication, Endpoints, EndpointsWithCustomErrors, JsonEntitiesFromCodecs, JsonEntitiesFromSchemas, LowLevelEndpoints, MuxEndpoints, Urls, JsonEntities, Endpoints, MuxEndpoints, Endpoints, EndpointsWithCustomErrors, Endpoints, EndpointsWithCustomErrors, MuxEndpoints
Type Hierarchy
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. Urls
  2. PartialInvariantFunctorSyntax
  3. InvariantFunctorSyntax
  4. AnyRef
  5. Any
Implicitly
  1. by StringFormat
  2. by Ensuring
  3. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. implicit class InvariantFunctorSyntax[A, F[_]] extends AnyRef

    Extension methods for values of type F[A] for which there is an implicit InvariantFunctor[F] instance.

    Extension methods for values of type F[A] for which there is an implicit InvariantFunctor[F] instance.

    Definition Classes
    InvariantFunctorSyntax
  2. implicit class PartialInvariantFunctorSyntax[A, F[_]] extends AnyRef
    Definition Classes
    PartialInvariantFunctorSyntax
  3. abstract type Path[A] <: Url[A]

    An URL path carrying an A information

    An URL path carrying an A information

    Note

    This type has implicit methods provided by the PathOps, InvariantFunctorSyntax, and the PartialInvariantFunctorSyntax classes.

  4. implicit class PathOps[A] extends AnyRef

    Convenient methods for Paths.

  5. abstract type QueryString[A]

    A query string carrying an A information

    A query string carrying an A information

    QueryString values can be created with the qs operation, and can be combined with the & operation:

    val queryPageAndLang: QueryString[(Int, Option[String])] =
  qs[Int]("page") & qs[Option[String]]("lang")
    Note

    This type has implicit methods provided by the QueryStringSyntax, InvariantFunctorSyntax, and the PartialInvariantFunctorSyntax classes.

  6. abstract type QueryStringParam[A]

    A query string parameter codec for type A.

    A query string parameter codec for type A.

    Note

    This type has implicit methods provided by the PartialInvariantFunctorSyntax and the InvariantFunctorSyntax classes.

  7. implicit class QueryStringSyntax[A] extends AnyRef

    Extension methods on QueryString.

  8. abstract type Segment[A]

    An URL path segment codec for type A.

    An URL path segment codec for type A.

    Note

    This type has implicit methods provided by the PartialInvariantFunctorSyntax and the InvariantFunctorSyntax classes.

  9. abstract type Url[A]

    An URL carrying an A information

    An URL carrying an A information

    Note

    This type has implicit methods provided by the PartialInvariantFunctorSyntax and InvariantFunctorSyntax classes.

Abstract Value Members

  1. abstract def chainPaths[A, B](first: Path[A], second: Path[B])(implicit tupler: Tupler[A, B]): Path[Out]

    Chains the two paths

  2. abstract def combineQueryStrings[A, B](first: QueryString[A], second: QueryString[B])(implicit tupler: Tupler[A, B]): QueryString[Out]

    Concatenates two QueryStrings

  3. implicit abstract def optionalQueryStringParam[A](implicit arg0: QueryStringParam[A]): QueryStringParam[Option[A]]

    Make a query string parameter optional:

    Make a query string parameter optional:

    path / "articles" /? qs[Option[Int]]("page")

    Client interpreters must omit optional query string parameters that are empty. Server interpreters must accept incoming requests whose optional query string parameters are missing. Server interpreters must report a failure for incoming requests whose optional query string parameters are present, but malformed.

  4. implicit abstract def pathPartialInvariantFunctor: PartialInvariantFunctor[Path]

    Provides xmap and xmapPartial operations.

    Provides xmap and xmapPartial operations.

    See also

    PartialInvariantFunctorSyntax and InvariantFunctorSyntax

  5. abstract def qs[A](name: String, docs: Documentation = None)(implicit value: QueryStringParam[A]): QueryString[A]

    Builds a QueryString with one parameter.

    Builds a QueryString with one parameter.

    Examples:

    qs[Int]("page")            // mandatory `page` parameter
qs[Option[String]]("lang") // optional `lang` parameter
qs[List[Long]]("id")       // repeated `id` parameter
    A

    Type of the value carried by the parameter

    name

    Parameter’s name

  6. implicit abstract def queryStringParamPartialInvariantFunctor: PartialInvariantFunctor[QueryStringParam]

    Provides xmap and xmapPartial operations.

    Provides xmap and xmapPartial operations.

    See also

    PartialInvariantFunctorSyntax and InvariantFunctorSyntax

  7. implicit abstract def queryStringPartialInvariantFunctor: PartialInvariantFunctor[QueryString]

    Provides xmap and xmapPartial operations.

    Provides xmap and xmapPartial operations.

    See also

    PartialInvariantFunctorSyntax and InvariantFunctorSyntax

  8. abstract def remainingSegments(name: String = "", docs: Documentation = None): Path[String]

    The remaining segments of the path.

    The remaining segments of the path. The String value carried by this Path is still URL-encoded.

  9. implicit abstract def repeatedQueryStringParam[A, CC[X] <: Iterable[X]](implicit arg0: QueryStringParam[A], factory: Factory[A, CC[A]]): QueryStringParam[CC[A]]

    Support query string parameters with multiple values:

    Support query string parameters with multiple values:

    path / "articles" /? qs[List[Long]]("id")

    Server interpreters must accept incoming requests where such parameters are missing (in such a case, its value is an empty collection), and report a failure if at least one value is malformed.

  10. abstract def segment[A](name: String = "", docs: Documentation = None)(implicit s: Segment[A]): Path[A]

    A path segment carrying an A information

  11. implicit abstract def segmentPartialInvariantFunctor: PartialInvariantFunctor[Segment]

    Provides xmap and xmapPartial operations.

    Provides xmap and xmapPartial operations.

    See also

    PartialInvariantFunctorSyntax and InvariantFunctorSyntax

  12. abstract def staticPathSegment(segment: String): Path[Unit]

    A path segment whose value is the given segment

  13. implicit abstract def stringQueryString: QueryStringParam[String]

    Ability to define String query string parameters

  14. implicit abstract def stringSegment: Segment[String]

    Ability to define String path segments Servers should return an URL-decoded string value, and clients should take an URL-decoded string value.

  15. implicit abstract def urlPartialInvariantFunctor: PartialInvariantFunctor[Url]

    Provides xmap and xmapPartial operations

    Provides xmap and xmapPartial operations

    See also

    PartialInvariantFunctorSyntax and InvariantFunctorSyntax

  16. abstract def urlWithQueryString[A, B](path: Path[A], qs: QueryString[B])(implicit tupler: Tupler[A, B]): Url[Out]

    Builds an URL from the given path and query string

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  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
    @inline()
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. implicit def booleanQueryString: QueryStringParam[Boolean]

    Query string parameter containing a Boolean value

  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. implicit def doubleQueryString: QueryStringParam[Double]

    Codec for query string parameters of type Double

  9. implicit def doubleSegment: Segment[Double]

    Segment codec for type Double

  10. implicit def dummyPathToUrl[A](p: Path[A]): Url[A]

    Implicit conversion to get rid of intellij errors when defining paths.

    Implicit conversion to get rid of intellij errors when defining paths. Effectively should not be called.

    See also

    https://youtrack.jetbrains.com/issue/SCL-16284

  11. 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
  12. 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
  13. 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
  14. 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
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  17. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  18. 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
    @inline()
  19. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  20. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  21. implicit def intQueryString: QueryStringParam[Int]

    Ability to define Int query string parameters

  22. implicit def intSegment: Segment[Int]

    Ability to define Int path segments

  23. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  24. implicit def longQueryString: QueryStringParam[Long]

    Query string parameter containing a Long value

  25. implicit def longSegment: Segment[Long]

    Segment containing a Long value

  26. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  28. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  29. val path: Path[Unit]

    An empty path.

    An empty path.

    Useful to begin a path definition:

    path / "foo" / segment[Int] /? qs[String]("bar")
  30. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  31. def toString(): String
    Definition Classes
    AnyRef → Any
  32. def tryParseString[A](type: String)(parse: (String) => A): (String) => Validated[A]
  33. implicit def uuidQueryString: QueryStringParam[UUID]

    Ability to define UUID query string parameters

  34. implicit def uuidSegment: Segment[UUID]

    Ability to define UUID path segments

  35. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  36. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  37. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. 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 endpoints.PartialInvariantFunctorSyntax

Inherited from endpoints.InvariantFunctorSyntax

Inherited from AnyRef

Inherited from Any

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]

Types

Types introduced by the algebra

Operations

Operations creating and transforming values

Ungrouped