Packages

trait Urls extends algebra.Urls with StatusCodes

algebra.Urls interpreter that decodes and encodes URLs.

Self Type
EndpointsWithCustomErrors
Source
Urls.scala
Linear Supertypes
StatusCodes, algebra.StatusCodes, algebra.Urls, endpoints4s.PartialInvariantFunctorSyntax, endpoints4s.InvariantFunctorSyntax, AnyRef, Any
Known Subclasses
BasicAuthentication, ChunkedEntities, ChunkedJsonEntities, Endpoints, EndpointsWithCustomErrors, JsonEntities, JsonEntitiesFromCodecs, JsonEntitiesFromEncodersAndDecoders, JsonEntitiesFromSchemas, MuxEndpoints
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Urls
  2. StatusCodes
  3. StatusCodes
  4. Urls
  5. PartialInvariantFunctorSyntax
  6. InvariantFunctorSyntax
  7. AnyRef
  8. 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 EndpointsWithCustomErrors.Url[A]
  4. implicit class PathOps[A] extends AnyRef
    Definition Classes
    Urls
  5. trait QueryString[T] extends AnyRef
  6. trait QueryStringParam[T] extends AnyRef

    Given a parameter name and a query string content, returns a decoded parameter value of type T, or Invalid if decoding failed

  7. implicit class QueryStringSyntax[A] extends AnyRef
    Definition Classes
    Urls
  8. trait Segment[A] extends AnyRef
  9. type StatusCode = akka.http.scaladsl.model.StatusCode
    Definition Classes
    StatusCodes → StatusCodes
  10. trait Url[A] extends AnyRef
  11. type WithDefault[A] = 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. def Accepted: Success
    Definition Classes
    StatusCodes → StatusCodes
  7. def AlreadyReported: Success
    Definition Classes
    StatusCodes → StatusCodes
  8. def BadRequest: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  9. def Conflict: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  10. def Created: Success
    Definition Classes
    StatusCodes → StatusCodes
  11. def ExpectationFailed: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  12. def FailedDependency: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  13. def Forbidden: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  14. def Gone: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  15. def IMUsed: Success
    Definition Classes
    StatusCodes → StatusCodes
  16. def InternalServerError: ServerError
    Definition Classes
    StatusCodes → StatusCodes
  17. def LengthRequired: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  18. def Locked: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  19. def MethodNotAllowed: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  20. def MisdirectedRequest: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  21. def MultiStatus: Success
    Definition Classes
    StatusCodes → StatusCodes
  22. def NoContent: Success
    Definition Classes
    StatusCodes → StatusCodes
  23. def NonAuthoritativeInformation: Success
    Definition Classes
    StatusCodes → StatusCodes
  24. def NotAcceptable: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  25. def NotFound: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  26. def NotImplemented: ServerError
    Definition Classes
    StatusCodes → StatusCodes
  27. def NotModified: Redirection
    Definition Classes
    StatusCodes → StatusCodes
  28. def OK: Success
    Definition Classes
    StatusCodes → StatusCodes
  29. def PartialContent: Success
    Definition Classes
    StatusCodes → StatusCodes
  30. def PayloadTooLarge: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  31. def PaymentRequired: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  32. def PermanentRedirect: Redirection
    Definition Classes
    StatusCodes → StatusCodes
  33. def PreconditionFailed: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  34. def PreconditionRequired: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  35. def ProxyAuthenticationRequired: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  36. def RangeNotSatisfiable: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  37. def RequestHeaderFieldsTooLarge: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  38. def RequestTimeout: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  39. def ResetContent: Success
    Definition Classes
    StatusCodes → StatusCodes
  40. def TemporaryRedirect: Redirection
    Definition Classes
    StatusCodes → StatusCodes
  41. def TooEarly: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  42. def TooManyRequests: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  43. def Unauthorized: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  44. def UnavailableForLegalReasons: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  45. def UnprocessableEntity: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  46. def UnsupportedMediaType: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  47. def UpgradeRequired: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  48. def UriTooLong: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  49. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  50. implicit def booleanQueryString: EndpointsWithCustomErrors.QueryStringParam[Boolean]
    Definition Classes
    Urls
  51. def chainPaths[A, B](first: EndpointsWithCustomErrors.Path[A], second: EndpointsWithCustomErrors.Path[B])(implicit tupler: Tupler[A, B]): EndpointsWithCustomErrors.Path[Out]
    Definition Classes
    Urls → Urls
  52. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  53. def combineQueryStrings[A, B](first: EndpointsWithCustomErrors.QueryString[A], second: EndpointsWithCustomErrors.QueryString[B])(implicit tupler: Tupler[A, B]): EndpointsWithCustomErrors.QueryString[Out]
    Definition Classes
    Urls → Urls
  54. def convToDirective1(directive: Directive0): Directive1[Unit]
    Attributes
    protected
  55. implicit def doubleQueryString: EndpointsWithCustomErrors.QueryStringParam[Double]
    Definition Classes
    Urls
  56. implicit def doubleSegment: EndpointsWithCustomErrors.Segment[Double]
    Definition Classes
    Urls
  57. 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
  58. 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
  59. 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
  60. 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
  61. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  62. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  63. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  64. def handleClientErrors(invalid: Invalid): StandardRoute

    This method is called by endpoints4s when decoding a request failed.

    This method is called by endpoints4s when decoding a request failed.

    The provided implementation calls clientErrorsResponse to complete with a response containing the errors.

    This method can be overridden to customize the error reporting logic.

  65. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  66. implicit def intQueryString: EndpointsWithCustomErrors.QueryStringParam[Int]
    Definition Classes
    Urls
  67. implicit def intSegment: EndpointsWithCustomErrors.Segment[Int]
    Definition Classes
    Urls
  68. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  69. def joinDirectives[T1, T2](dir1: Directive1[T1], dir2: Directive1[T2])(implicit tupler: Tupler[T1, T2]): Directive1[Out]

    Simpler alternative to Directive.&() method

    Simpler alternative to Directive.&() method

    Attributes
    protected
  70. implicit def longQueryString: EndpointsWithCustomErrors.QueryStringParam[Long]
    Definition Classes
    Urls
  71. implicit def longSegment: EndpointsWithCustomErrors.Segment[Long]
    Definition Classes
    Urls
  72. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  73. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  74. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  75. def optQsWithDefault[A](name: String, default: A, docs: Documentation = None)(implicit value: EndpointsWithCustomErrors.QueryStringParam[A]): EndpointsWithCustomErrors.QueryString[EndpointsWithCustomErrors.WithDefault[A]]
    Definition Classes
    Urls → Urls
  76. implicit def optionalQueryStringParam[A](implicit param: EndpointsWithCustomErrors.QueryStringParam[A]): EndpointsWithCustomErrors.QueryStringParam[Option[A]]
    Definition Classes
    Urls → Urls
  77. val path: EndpointsWithCustomErrors.Path[Unit]
    Definition Classes
    Urls
  78. implicit lazy val pathPartialInvariantFunctor: PartialInvariantFunctor[EndpointsWithCustomErrors.Path]
    Definition Classes
    Urls → Urls
  79. def qs[A](name: String, docs: Documentation)(implicit param: EndpointsWithCustomErrors.QueryStringParam[A]): EndpointsWithCustomErrors.QueryString[A]
    Definition Classes
    Urls → Urls
  80. implicit lazy val queryStringParamPartialInvariantFunctor: PartialInvariantFunctor[EndpointsWithCustomErrors.QueryStringParam]
    Definition Classes
    Urls → Urls
  81. implicit lazy val queryStringPartialInvariantFunctor: PartialInvariantFunctor[EndpointsWithCustomErrors.QueryString]
    Definition Classes
    Urls → Urls
  82. def remainingSegments(name: String, docs: Documentation): EndpointsWithCustomErrors.Path[String]
    Definition Classes
    Urls → Urls
  83. implicit def repeatedQueryStringParam[A, CC[X] <: Iterable[X]](implicit param: EndpointsWithCustomErrors.QueryStringParam[A], factory: Factory[A, CC[A]]): EndpointsWithCustomErrors.QueryStringParam[CC[A]]
    Definition Classes
    Urls → Urls
  84. def segment[A](name: String, docs: Documentation)(implicit s: EndpointsWithCustomErrors.Segment[A]): EndpointsWithCustomErrors.Path[A]
    Definition Classes
    Urls → Urls
  85. implicit lazy val segmentPartialInvariantFunctor: PartialInvariantFunctor[EndpointsWithCustomErrors.Segment]
    Definition Classes
    Urls → Urls
  86. def staticPathSegment(segment: String): EndpointsWithCustomErrors.Path[Unit]
    Definition Classes
    Urls → Urls
  87. implicit lazy val stringQueryString: EndpointsWithCustomErrors.QueryStringParam[String]
    Definition Classes
    Urls → Urls
  88. implicit def stringSegment: EndpointsWithCustomErrors.Segment[String]
    Definition Classes
    Urls → Urls
  89. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  90. def toString(): String
    Definition Classes
    AnyRef → Any
  91. implicit lazy val urlPartialInvariantFunctor: PartialInvariantFunctor[EndpointsWithCustomErrors.Url]
    Definition Classes
    Urls → Urls
  92. def urlWithQueryString[A, B](path: EndpointsWithCustomErrors.Path[A], qs: EndpointsWithCustomErrors.QueryString[B])(implicit tupler: Tupler[A, B]): EndpointsWithCustomErrors.Url[Out]
    Definition Classes
    Urls → Urls
  93. implicit def uuidQueryString: EndpointsWithCustomErrors.QueryStringParam[UUID]
    Definition Classes
    Urls
  94. implicit def uuidSegment: EndpointsWithCustomErrors.Segment[UUID]
    Definition Classes
    Urls
  95. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  96. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  97. 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 StatusCodes

Inherited from algebra.StatusCodes

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