Urls

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

Assets, BasicAuthentication, ChunkedEntities, ChunkedJsonEntities, Endpoints, EndpointsWithCustomErrors, JsonEntitiesFromCodecs, JsonEntitiesFromEncodersAndDecoders, JsonEntitiesFromSchemas, MuxEndpoints

Type Hierarchy

Ordering

Grouped
Alphabetic
By Inheritance

Inherited

Urls
StatusCodes
StatusCodes
Urls
PartialInvariantFunctorSyntax
InvariantFunctorSyntax
AnyRef
Any

Implicitly

by any2stringadd
by StringFormat
by Ensuring
by ArrowAssoc

Hide All
Show All

Visibility

Public
Protected

Type Members

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
implicit class PartialInvariantFunctorSyntax[A, F[_]] extends AnyRef
Definition Classes
PartialInvariantFunctorSyntax
implicit class PathOps[A] extends AnyRef
Convenient methods for Paths.
Convenient methods for Paths.
Definition Classes
Urls
implicit class QueryStringSyntax[A] extends AnyRef
Extension methods on QueryString.
Extension methods on QueryString.
Definition Classes
Urls
abstract type Effect[A]
type Params = Map[String, Seq[String]]
trait Path[A] extends EndpointsWithCustomErrors.Url[A]
type QueryString[A] = (EndpointsWithCustomErrors.Params) => Validated[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")
```
- Server interpreters raise an error if they can’t parse the incoming request query string parameters as a value of type A. By default, they produce a Bad Request (400) response with a list of error messages in a JSON array. Refer to the documentation of your server interpreter to customize this behavior.
Definition Classes
Urls → Urls
Note
This type has implicit methods provided by the QueryStringSyntax, InvariantFunctorSyntax, and the PartialInvariantFunctorSyntax classes.
trait QueryStringParam[A] extends AnyRef
trait Segment[A] extends AnyRef
type StatusCode = Status
HTTP Status Code
HTTP Status Code
Definition Classes
StatusCodes → StatusCodes
trait Url[A] extends AnyRef
type WithDefault[A] = A
This type is necessary to express different perspectives of servers and clients on optional query string parameters with default value:
This type is necessary to express different perspectives of servers and clients on optional query string parameters with default value:
- Client interpreters should define it as Option[A] and omit query string parameters with default value that are empty
- Server interpreters should define it as A and accept incoming requests whose query string parameters with default value are missing, while providing the defined default value
- Documentation interpreters should mark the parameter as optional and document the provided default value
Definition Classes
Urls → Urls

Value Members

final def !=(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def ##: Int
Definition Classes
AnyRef → Any
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
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()
final def ==(arg0: Any): Boolean
Definition Classes
AnyRef → Any
def Accepted: Status
Definition Classes
StatusCodes → StatusCodes
def AlreadyReported: Status
Definition Classes
StatusCodes → StatusCodes
def BadRequest: Status
Definition Classes
StatusCodes → StatusCodes
Note
You should use the badRequest constructor provided by the endpoints4s.algebra.Responses trait to ensure that errors produced by endpoints4s are consistently handled by interpreters.
def Conflict: Status
Definition Classes
StatusCodes → StatusCodes
def Created: Status
Definition Classes
StatusCodes → StatusCodes
def ExpectationFailed: Status
Definition Classes
StatusCodes → StatusCodes
def FailedDependency: Status
Definition Classes
StatusCodes → StatusCodes
def Forbidden: Status
Definition Classes
StatusCodes → StatusCodes
def Gone: Status
Definition Classes
StatusCodes → StatusCodes
def IMUsed: Status
Definition Classes
StatusCodes → StatusCodes
def InternalServerError: Status
Definition Classes
StatusCodes → StatusCodes
Note
You should use the internalServerError constructor provided by the endpoints4s.algebra.Responses trait to ensure that errors produced by endpoints4s are consistently handled by interpreters.
def LengthRequired: Status
Definition Classes
StatusCodes → StatusCodes
def Locked: Status
Definition Classes
StatusCodes → StatusCodes
def MethodNotAllowed: Status
Definition Classes
StatusCodes → StatusCodes
def MisdirectedRequest: Status
Definition Classes
StatusCodes → StatusCodes
def MultiStatus: Status
Definition Classes
StatusCodes → StatusCodes
def NoContent: Status
Definition Classes
StatusCodes → StatusCodes
def NonAuthoritativeInformation: Status
Definition Classes
StatusCodes → StatusCodes
def NotAcceptable: Status
Definition Classes
StatusCodes → StatusCodes
def NotFound: Status
Definition Classes
StatusCodes → StatusCodes
def NotImplemented: Status
Definition Classes
StatusCodes → StatusCodes
def NotModified: Status
Definition Classes
StatusCodes → StatusCodes
def OK: Status
Definition Classes
StatusCodes → StatusCodes
def PartialContent: Status
Definition Classes
StatusCodes → StatusCodes
def PayloadTooLarge: Status
Definition Classes
StatusCodes → StatusCodes
def PaymentRequired: Status
Definition Classes
StatusCodes → StatusCodes
def PermanentRedirect: Status
Definition Classes
StatusCodes → StatusCodes
def PreconditionFailed: Status
Definition Classes
StatusCodes → StatusCodes
def PreconditionRequired: Status
Definition Classes
StatusCodes → StatusCodes
def ProxyAuthenticationRequired: Status
Definition Classes
StatusCodes → StatusCodes
def RangeNotSatisfiable: Status
Definition Classes
StatusCodes → StatusCodes
def RequestHeaderFieldsTooLarge: Status
Definition Classes
StatusCodes → StatusCodes
def RequestTimeout: Status
Definition Classes
StatusCodes → StatusCodes
def ResetContent: Status
Definition Classes
StatusCodes → StatusCodes
def TemporaryRedirect: Status
Definition Classes
StatusCodes → StatusCodes
def TooEarly: Status
Definition Classes
StatusCodes → StatusCodes
def TooManyRequests: Status
Definition Classes
StatusCodes → StatusCodes
def Unauthorized: Status
Definition Classes
StatusCodes → StatusCodes
def UnavailableForLegalReasons: Status
Definition Classes
StatusCodes → StatusCodes
def UnprocessableEntity: Status
Definition Classes
StatusCodes → StatusCodes
def UnsupportedMediaType: Status
Definition Classes
StatusCodes → StatusCodes
def UpgradeRequired: Status
Definition Classes
StatusCodes → StatusCodes
def UriTooLong: Status
Definition Classes
StatusCodes → StatusCodes
final def asInstanceOf[T0]: T0
Definition Classes
Any
implicit def booleanQueryString: EndpointsWithCustomErrors.QueryStringParam[Boolean]
Query string parameter containing a Boolean value
Query string parameter containing a Boolean value
Definition Classes
Urls
def chainPaths[A, B](first: EndpointsWithCustomErrors.Path[A], second: EndpointsWithCustomErrors.Path[B])(implicit tupler: Tupler[A, B]): EndpointsWithCustomErrors.Path[Out]
Chains the two paths
Chains the two paths
Definition Classes
Urls → Urls
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
def combineQueryStrings[A, B](first: EndpointsWithCustomErrors.QueryString[A], second: EndpointsWithCustomErrors.QueryString[B])(implicit tupler: Tupler[A, B]): EndpointsWithCustomErrors.QueryString[Out]
Concatenates two QueryStrings
Concatenates two QueryStrings
Definition Classes
Urls → Urls
implicit def doubleQueryString: EndpointsWithCustomErrors.QueryStringParam[Double]
Codec for query string parameters of type Double
Codec for query string parameters of type Double
Definition Classes
Urls
implicit def doubleSegment: EndpointsWithCustomErrors.Segment[Double]
Path segment codec for type Double
Path segment codec for type Double
Definition Classes
Urls
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
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
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
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
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(arg0: AnyRef): Boolean
Definition Classes
AnyRef → Any
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@IntrinsicCandidate() @native()
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@IntrinsicCandidate() @native()
implicit def intQueryString: EndpointsWithCustomErrors.QueryStringParam[Int]
Ability to define Int query string parameters
Ability to define Int query string parameters
Definition Classes
Urls
implicit def intSegment: EndpointsWithCustomErrors.Segment[Int]
Path segment codec for type Int
Path segment codec for type Int
Definition Classes
Urls
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
implicit def longQueryString: EndpointsWithCustomErrors.QueryStringParam[Long]
Query string parameter containing a Long value
Query string parameter containing a Long value
Definition Classes
Urls
implicit def longSegment: EndpointsWithCustomErrors.Segment[Long]
Path segment codec for type Long
Path segment codec for type Long
Definition Classes
Urls
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
final def notify(): Unit
Definition Classes
AnyRef
Annotations
@IntrinsicCandidate() @native()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@IntrinsicCandidate() @native()
def optQsWithDefault[A](name: String, default: A, docs: Documentation = None)(implicit value: EndpointsWithCustomErrors.QueryStringParam[A]): EndpointsWithCustomErrors.QueryString[EndpointsWithCustomErrors.WithDefault[A]]
Builds a QueryString with one optional parameter, which has a default value.
Builds a QueryString with one optional parameter, which has a default value.
Examples:
```
optQsWithDefault[Int]("page", 1) // optional `page` parameter, with default value 1
```
A
Type of the value carried by the parameter
name
Parameter’s name
Definition Classes
Urls → Urls
implicit def optionalQueryStringParam[A](implicit param: EndpointsWithCustomErrors.QueryStringParam[A]): EndpointsWithCustomErrors.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, and they must report a failure for incoming requests whose optional query string parameters are present, but malformed,
- Documentation interpreters should mark the parameter as optional.
Definition Classes
Urls → Urls
val path: EndpointsWithCustomErrors.Path[Unit]
An empty path.
An empty path.
Useful to begin a path definition:
```
path / "foo" / segment[Int] /? qs[String]("bar")
```
Definition Classes
Urls
implicit def pathPartialInvariantFunctor: PartialInvariantFunctor[EndpointsWithCustomErrors.Path]
Provides xmap and xmapPartial operations.
Provides xmap and xmapPartial operations.
Definition Classes
Urls → Urls
See also
PartialInvariantFunctorSyntax and InvariantFunctorSyntax
def qs[A](name: String, docs: Documentation = None)(implicit value: EndpointsWithCustomErrors.QueryStringParam[A]): EndpointsWithCustomErrors.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
Definition Classes
Urls → Urls
implicit def queryStringParamPartialInvariantFunctor: PartialInvariantFunctor[EndpointsWithCustomErrors.QueryStringParam]
Provides xmap and xmapPartial operations.
Provides xmap and xmapPartial operations.
Definition Classes
Urls → Urls
See also
PartialInvariantFunctorSyntax and InvariantFunctorSyntax
implicit def queryStringPartialInvariantFunctor: PartialInvariantFunctor[EndpointsWithCustomErrors.QueryString]
Provides xmap and xmapPartial operations.
Provides xmap and xmapPartial operations.
Definition Classes
Urls → Urls
See also
PartialInvariantFunctorSyntax and InvariantFunctorSyntax
def remainingSegments(name: String = "", docs: Documentation = None): EndpointsWithCustomErrors.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.
Definition Classes
Urls → Urls
implicit def repeatedQueryStringParam[A, CC[X] <: Iterable[X]](implicit param: EndpointsWithCustomErrors.QueryStringParam[A], factory: Factory[A, CC[A]]): EndpointsWithCustomErrors.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.
Definition Classes
Urls → Urls
def segment[A](name: String = "", docs: Documentation = None)(implicit A: EndpointsWithCustomErrors.Segment[A]): EndpointsWithCustomErrors.Path[A]
A path segment carrying an A information
A path segment carrying an A information
Definition Classes
Urls → Urls
implicit def segmentPartialInvariantFunctor: PartialInvariantFunctor[EndpointsWithCustomErrors.Segment]
Provides xmap and xmapPartial operations.
Provides xmap and xmapPartial operations.
Definition Classes
Urls → Urls
See also
PartialInvariantFunctorSyntax and InvariantFunctorSyntax
def staticPathSegment(segment: String): EndpointsWithCustomErrors.Path[Unit]
A path segment whose value is the given segment
A path segment whose value is the given segment
Definition Classes
Urls → Urls
implicit def stringQueryString: EndpointsWithCustomErrors.QueryStringParam[String]
Ability to define String query string parameters
Ability to define String query string parameters
Definition Classes
Urls → Urls
implicit def stringSegment: EndpointsWithCustomErrors.Segment[String]
Path segment codec for type String
Path segment codec for type String
- Server interpreters should return an URL-decoded string value,
- Client interpreters should take an URL-decoded string value.
Definition Classes
Urls → Urls
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
def toString(): String
Definition Classes
AnyRef → Any
implicit def urlPartialInvariantFunctor: PartialInvariantFunctor[EndpointsWithCustomErrors.Url]
Provides xmap and xmapPartial operations
Provides xmap and xmapPartial operations
Definition Classes
Urls → Urls
See also
PartialInvariantFunctorSyntax and InvariantFunctorSyntax
def urlWithQueryString[A, B](path: EndpointsWithCustomErrors.Path[A], qs: EndpointsWithCustomErrors.QueryString[B])(implicit tupler: Tupler[A, B]): EndpointsWithCustomErrors.Url[Out]
Builds an URL from the given path and query string
Builds an URL from the given path and query string
Definition Classes
Urls → Urls
val utf8Name: String
implicit def uuidQueryString: EndpointsWithCustomErrors.QueryStringParam[UUID]
Ability to define UUID query string parameters
Ability to define UUID query string parameters
Definition Classes
Urls
implicit def uuidSegment: EndpointsWithCustomErrors.Segment[UUID]
Path segment codec for type UUID
Path segment codec for type UUID
Definition Classes
Urls
final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

def finalize(): Unit
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable]) @Deprecated
Deprecated
(Since version 9)
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.
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.

Packages

Urls

trait Urls extends algebra.Urls with StatusCodes

Type Members

Value Members

Deprecated Value Members

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]

Types

Operations

Ungrouped

Packages

Urls

trait Urls extends algebra.Urls with StatusCodes

Type Members

Value Members

Deprecated Value Members

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]

Types

Operations

Ungrouped

Urls