Packages

trait Requests extends algebra.Requests with Urls with Methods with Headers

Interpreter for algebra.Requests.

Source
Requests.scala
Type Hierarchy
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. Requests
  2. Headers
  3. Methods
  4. Urls
  5. Requests
  6. SemigroupalSyntax
  7. Methods
  8. Urls
  9. PartialInvariantFunctorSyntax
  10. InvariantFunctorSyntax
  11. AnyRef
  12. 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

    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
  3. implicit class SemigroupalSyntax[A, F[_]] extends AnyRef
    Definition Classes
    SemigroupalSyntax
  4. implicit class RequestEntitySyntax[A] extends AnyRef
    Definition Classes
    Requests
  5. implicit final class RequestSyntax[A] extends AnyRef

    Extension methods for Request.

    Extension methods for Request.

    Definition Classes
    Requests
  6. implicit class PathOps[A] extends AnyRef

    Convenient methods for Paths.

    Convenient methods for Paths.

    Definition Classes
    Urls
  7. implicit class QueryStringSyntax[A] extends AnyRef

    Extension methods on QueryString.

    Extension methods on QueryString.

    Definition Classes
    Urls
  8. case class DocumentedHeader(name: String, description: Option[String], required: Boolean, schema: Schema) extends Product with Serializable
    Definition Classes
    Headers
  9. case class DocumentedHeaders(value: List[DocumentedHeader]) extends Product with Serializable

    value

    List of request header names (e.g. “Authorization”)

    Definition Classes
    Headers
  10. sealed trait Method extends AnyRef
    Definition Classes
    Methods
  11. case class DocumentedRequest(method: Requests.Method, url: Requests.DocumentedUrl, headers: Requests.DocumentedHeaders, documentation: Documentation, entity: Map[String, MediaType]) extends Product with Serializable
  12. type Path[A] = DocumentedUrl

    An URL path carrying an A information

    An URL path carrying an A information

    Values of type Path[A] can be constructed by the operations path, segment, and remainingSegments.

    path / "user" / segment[UUID]("id")
    • Server interpreters raise an error if they can’t parse the incoming request path 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
    UrlsUrls
    Note

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

  13. type QueryString[A] = DocumentedQueryString

    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
    UrlsUrls
    Note

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

  14. type QueryStringParam[A] = DocumentedQueryStringParam[A]

    A query string parameter codec for type A.

    A query string parameter codec for type A.

    The trait Urls provides implicit instances of type QueryStringParam[A] for basic types (e.g., Int, String, etc.). You can create additional instances by transforming or refining the existing instances with xmap and xmapPartial.

    Definition Classes
    UrlsUrls
    Note

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

  15. type Request[A] = DocumentedRequest

    Information carried by a whole request (headers and entity)

    Information carried by a whole request (headers and entity)

    Values of type Request[A] can be constructed by using the operations request, get, post, put, or delete.

    • Server interpreters raise an error if they can’t parse the incoming request 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
    RequestsRequests
    Note

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

  16. type RequestEntity[A] = Map[String, MediaType]

    Information carried by request entity

    Information carried by request entity

    Values of type RequestEntity[A] can be constructed by using the operations emptyRequest or textRequest. Additional types of request entities are provided by other algebra modules, such as JsonEntities or ChunkedEntities.

    • Server interpreters raise an error if they can’t parse the incoming request entity 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
    RequestsRequests
    Note

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

  17. type RequestHeaders[A] = DocumentedHeaders

    Information carried by requests’ headers.

    Information carried by requests’ headers.

    You can construct values of type RequestHeaders by using the operations requestHeader, optRequestHeader, or emptyRequestHeaders.

    • Server interpreters raise an error if they can’t parse the incoming request headers 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
    RequestsRequests
    Note

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

  18. type Segment[A] = Schema

    An URL path segment codec for type A.

    An URL path segment codec for type A.

    The trait Urls provides implicit instances of Segment[A] for basic types (e.g., Int, String, etc.). You can create additional instances by transforming or refining the existing instances with xmap and xmapPartial.

    Definition Classes
    UrlsUrls
    Note

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

  19. type Url[A] = DocumentedUrl

    An URL carrying an A information

    An URL carrying an A information

    Values of type URL[A] are typically constructed by first using the path constructor and then chaining it with segments and query parameters.

    path / "users" / segment[UUID]("id") /? qs[String]("apiKey")
    • Server interpreters raise an error if they can’t parse the incoming request URL 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
    UrlsUrls
    Note

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

  20. 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
    UrlsUrls
  21. case class DocumentedParameter(name: String, required: Boolean, description: Option[String], schema: Schema) extends Product with Serializable

    name

    Name of the parameter

    required

    Whether this parameter is required or not (MUST be true for path parameters)

    Definition Classes
    Urls
  22. case class DocumentedQueryString(parameters: List[DocumentedParameter]) extends Product with Serializable

    parameters

    List of query string parameters

    Definition Classes
    Urls
  23. case class DocumentedQueryStringParam[A](schema: Schema, isRequired: Boolean, encoder: Encoder[A, Option[Value]]) extends Product with Serializable

    A query string parameter documentation description for type A

    A query string parameter documentation description for type A

    schema

    Schema that corresponds to type A

    isRequired

    Whether the query string parameter is required

    encoder

    JSON encoder for query string parameter value, primarily used for encoding of the parameter's default value. Result of the encoding is optional since the empty value of optional query string parameter should result in the empty encoded value.

    Definition Classes
    Urls
  24. case class DocumentedUrl(path: List[Either[String, DocumentedParameter]], queryParameters: List[DocumentedParameter]) extends Product with Serializable

    path

    List of path segments. Left is a static segment, right is a path parameter

    queryParameters

    Query string parameters

    Definition Classes
    Urls

Value Members

  1. case object Delete extends Method with Product with Serializable

    Definition Classes
    MethodsMethods
  2. case object Get extends Method with Product with Serializable

    Definition Classes
    MethodsMethods
  3. case object Options extends Method with Product with Serializable

    Definition Classes
    MethodsMethods
  4. case object Patch extends Method with Product with Serializable

    Definition Classes
    MethodsMethods
  5. case object Post extends Method with Product with Serializable

    Definition Classes
    MethodsMethods
  6. case object Put extends Method with Product with Serializable

    Definition Classes
    MethodsMethods
  7. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. final def ##: Int
    Definition Classes
    AnyRef → Any
  9. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from Requests toany2stringadd[Requests] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  10. def ->[B](y: B): (Requests, B)
    Implicit
    This member is added by an implicit conversion from Requests toArrowAssoc[Requests] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  11. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  12. def addRequestHeaders[A, H](request: Request[A], headers: RequestHeaders[H])(implicit tupler: Tupler[A, H]): Request[Out]

    Add the provided headers to the request.

    Add the provided headers to the request.

    Definition Classes
    RequestsRequests
  13. def addRequestQueryString[A, Q](request: Request[A], qs: QueryString[Q])(implicit tupler: Tupler[A, Q]): Request[Out]

    Add the provided queryString to the request.

    Add the provided queryString to the request.

    Definition Classes
    RequestsRequests
  14. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  15. def booleanQueryString: QueryStringParam[Boolean]

    Query string parameter containing a Boolean value

    Query string parameter containing a Boolean value

    Definition Classes
    UrlsUrls
  16. def chainPaths[A, B](first: Path[A], second: Path[B])(implicit tupler: Tupler[A, B]): Path[Out]

    Chains the two paths

    Chains the two paths

    Definition Classes
    UrlsUrls
  17. def choiceRequestEntity[A, B](requestEntityA: Map[String, MediaType], requestEntityB: Map[String, MediaType]): Map[String, MediaType]

    Alternative between two possible request entities, differentiated by the Content-Type header

    Alternative between two possible request entities, differentiated by the Content-Type header

    Definition Classes
    RequestsRequests
    Note

    If A and B are both JSON-encoded and use disjoint schemas, use endpoints4s.algebra.JsonSchemas.TaggedOps#orElse at the schema level instead

    • Server interpreters accept either of the request entities
    • Client interpreters provide one of the two request entities
    • Documentation interpreters list all possible content types and their entities
  18. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  19. def combineQueryStrings[A, B](first: QueryString[A], second: QueryString[B])(implicit tupler: Tupler[A, B]): QueryString[Out]

    Concatenates two QueryStrings

    Concatenates two QueryStrings

    Definition Classes
    UrlsUrls
  20. final def delete[UrlP, HeadersP, Out](url: Url[UrlP], docs: Documentation = None, headers: RequestHeaders[HeadersP] = emptyRequestHeaders)(implicit tuplerUH: Tupler.Aux[UrlP, HeadersP, Out]): Request[Out]

    Helper method to perform DELETE request

    Helper method to perform DELETE request

    UrlP

    Payload carried by url

    HeadersP

    Payload carried by headers

    Definition Classes
    Requests
  21. def doubleQueryString: QueryStringParam[Double]

    Codec for query string parameters of type Double

    Codec for query string parameters of type Double

    Definition Classes
    UrlsUrls
  22. def doubleSegment: Segment[Double]

    Path segment codec for type Double

    Path segment codec for type Double

    Definition Classes
    UrlsUrls
  23. lazy val emptyRequest: Map[String, MediaType]

    Empty request -- request without a body.

    Empty request -- request without a body. Use description of endpoints4s.algebra.Endpoints#endpoint to document an empty body.

    Definition Classes
    RequestsRequests
  24. def emptyRequestHeaders: DocumentedHeaders

    Ignore headers

    Ignore headers

    • Server interpreters don’t try to parse any information from the request headers,
    • Client interpreters supply no specific headers

    Use description of endpoints4s.algebra.Endpoints#endpoint to document empty headers.

    Definition Classes
    RequestsRequests
  25. def ensuring(cond: (Requests) => Boolean, msg: => Any): Requests
    Implicit
    This member is added by an implicit conversion from Requests toEnsuring[Requests] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  26. def ensuring(cond: (Requests) => Boolean): Requests
    Implicit
    This member is added by an implicit conversion from Requests toEnsuring[Requests] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  27. def ensuring(cond: Boolean, msg: => Any): Requests
    Implicit
    This member is added by an implicit conversion from Requests toEnsuring[Requests] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  28. def ensuring(cond: Boolean): Requests
    Implicit
    This member is added by an implicit conversion from Requests toEnsuring[Requests] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  29. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  30. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  31. final def get[UrlP, HeadersP, Out](url: Url[UrlP], docs: Documentation = None, headers: RequestHeaders[HeadersP] = emptyRequestHeaders)(implicit tuplerUH: Tupler.Aux[UrlP, HeadersP, Out]): Request[Out]

    Helper method to perform GET request

    Helper method to perform GET request

    UrlP

    Payload carried by url

    HeadersP

    Payload carried by headers

    Definition Classes
    Requests
  32. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  33. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  34. def intQueryString: QueryStringParam[Int]

    Ability to define Int query string parameters

    Ability to define Int query string parameters

    Definition Classes
    UrlsUrls
  35. def intSegment: Segment[Int]

    Path segment codec for type Int

    Path segment codec for type Int

    Definition Classes
    UrlsUrls
  36. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  37. def longQueryString: QueryStringParam[Long]

    Query string parameter containing a Long value

    Query string parameter containing a Long value

    Definition Classes
    UrlsUrls
  38. def longSegment: Segment[Long]

    Path segment codec for type Long

    Path segment codec for type Long

    Definition Classes
    UrlsUrls
  39. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  40. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  41. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  42. def optQsWithDefault[A](name: String, default: A, docs: Documentation = None)(implicit value: QueryStringParam[A]): QueryString[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
    UrlsUrls
  43. def optRequestHeader(name: String, docs: Documentation): RequestHeaders[Option[String]]

    An optional request header

    An optional request header

    name

    Header name (e.g., “Authorization”)

    Definition Classes
    RequestsRequests
  44. implicit def optionalQueryStringParam[A](implicit param: 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, 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
    UrlsUrls
  45. final def patch[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](url: Url[UrlP], entity: RequestEntity[BodyP], docs: Documentation = None, headers: RequestHeaders[HeadersP] = emptyRequestHeaders)(implicit tuplerUB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Tupler.Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]

    Helper method to perform PATCH request

    Helper method to perform PATCH request

    UrlP

    Payload carried by url

    BodyP

    Payload carried by body

    HeadersP

    Payload carried by headers

    UrlAndBodyPTupled

    Payloads of Url and Body tupled together by Tupler

    docs

    Request documentation

    Definition Classes
    Requests
  46. val path: Path[Unit]

    An empty path.

    An empty path.

    Useful to begin a path definition:

    path / "foo" / segment[Int] /? qs[String]("bar")
    Definition Classes
    Urls
  47. implicit lazy val pathPartialInvariantFunctor: PartialInvariantFunctor[Path]

    Provides xmap and xmapPartial operations.

    Provides xmap and xmapPartial operations.

    Definition Classes
    UrlsUrls
    See also

    PartialInvariantFunctorSyntax and InvariantFunctorSyntax

  48. final def post[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](url: Url[UrlP], entity: RequestEntity[BodyP], docs: Documentation = None, headers: RequestHeaders[HeadersP] = emptyRequestHeaders)(implicit tuplerUB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Tupler.Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]

    Helper method to perform POST request

    Helper method to perform POST request

    UrlP

    Payload carried by url

    BodyP

    Payload carried by body

    HeadersP

    Payload carried by headers

    UrlAndBodyPTupled

    Payloads of Url and Body tupled together by Tupler

    docs

    Request documentation

    Definition Classes
    Requests
  49. final def put[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](url: Url[UrlP], entity: RequestEntity[BodyP], docs: Documentation = None, headers: RequestHeaders[HeadersP] = emptyRequestHeaders)(implicit tuplerUB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Tupler.Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]

    Helper method to perform PUT request

    Helper method to perform PUT request

    UrlP

    Payload carried by url

    BodyP

    Payload carried by body

    HeadersP

    Payload carried by headers

    UrlAndBodyPTupled

    Payloads of Url and Body tupled together by Tupler

    Definition Classes
    Requests
  50. def qs[A](name: String, docs: Documentation)(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

    Definition Classes
    UrlsUrls
  51. implicit lazy val queryStringParamPartialInvariantFunctor: PartialInvariantFunctor[QueryStringParam]

    Provides xmap and xmapPartial operations.

    Provides xmap and xmapPartial operations.

    Definition Classes
    UrlsUrls
    See also

    PartialInvariantFunctorSyntax and InvariantFunctorSyntax

  52. implicit lazy val queryStringPartialInvariantFunctor: PartialInvariantFunctor[QueryString]

    Provides xmap and xmapPartial operations.

    Provides xmap and xmapPartial operations.

    Definition Classes
    UrlsUrls
    See also

    PartialInvariantFunctorSyntax and InvariantFunctorSyntax

  53. def remainingSegments(name: String, docs: Documentation): 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
    UrlsUrls
  54. implicit def repeatedQueryStringParam[A, CC[X] <: Iterable[X]](implicit param: 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.
    Definition Classes
    UrlsUrls
  55. def request[A, B, C, AB, Out](method: Method, url: Url[A], entity: RequestEntity[B] = emptyRequest, docs: Documentation = None, headers: RequestHeaders[C] = emptyRequestHeaders)(implicit tuplerAB: Tupler.Aux[A, B, AB], tuplerABC: Tupler.Aux[AB, C, Out]): Request[Out]

    Request for given parameters

    Request for given parameters

    method

    Request method

    url

    Request URL

    entity

    Request entity

    docs

    Request documentation

    headers

    Request headers

    Definition Classes
    RequestsRequests
  56. implicit lazy val requestEntityPartialInvariantFunctor: PartialInvariantFunctor[RequestEntity]

    Provides the operations xmap and xmapPartial.

    Provides the operations xmap and xmapPartial.

    Definition Classes
    RequestsRequests
    See also

    PartialInvariantFunctorSyntax

  57. def requestHeader(name: String, docs: Documentation): RequestHeaders[String]

    A required request header

    A required request header

    name

    Header name (e.g., “Authorization”)

    Definition Classes
    RequestsRequests
  58. implicit lazy val requestHeadersPartialInvariantFunctor: PartialInvariantFunctor[RequestHeaders]

    Provides the operations xmap and xmapPartial.

    Provides the operations xmap and xmapPartial.

    Definition Classes
    RequestsRequests
    See also

    PartialInvariantFunctorSyntax

  59. implicit lazy val requestHeadersSemigroupal: Semigroupal[RequestHeaders]

    Provides ++ operation.

    Provides ++ operation.

    Definition Classes
    RequestsRequests
    See also

    SemigroupalSyntax

  60. implicit def requestPartialInvariantFunctor: PartialInvariantFunctor[Request]

    Provides the operations xmap and xmapPartial.

    Provides the operations xmap and xmapPartial.

    Definition Classes
    RequestsRequests
    See also

    PartialInvariantFunctorSyntax

  61. def segment[A](name: String, docs: Documentation)(implicit A: Segment[A]): Path[A]

    A path segment carrying an A information

    A path segment carrying an A information

    Definition Classes
    UrlsUrls
  62. implicit lazy val segmentPartialInvariantFunctor: PartialInvariantFunctor[Segment]

    Provides xmap and xmapPartial operations.

    Provides xmap and xmapPartial operations.

    Definition Classes
    UrlsUrls
    See also

    PartialInvariantFunctorSyntax and InvariantFunctorSyntax

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

    A path segment whose value is the given segment

    A path segment whose value is the given segment

    Definition Classes
    UrlsUrls
  64. def stringQueryString: QueryStringParam[String]

    Ability to define String query string parameters

    Ability to define String query string parameters

    Definition Classes
    UrlsUrls
  65. def stringSegment: 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
    UrlsUrls
  66. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  67. lazy val textRequest: Map[String, MediaType]

    Request with a String body.

    Request with a String body.

    • Server interpreters accept requests with content-type text/plain and reject requests with an incorrect content-type.
    • Server interpreters will use the character encoding set in the content-type header to determine how the text is decoded.
    • Client interpreters supply content-type text/plain with an explicit character encoding
    Definition Classes
    RequestsRequests
  68. def toString(): String
    Definition Classes
    AnyRef → Any
  69. implicit lazy val urlPartialInvariantFunctor: PartialInvariantFunctor[Url]

    Provides xmap and xmapPartial operations

    Provides xmap and xmapPartial operations

    Definition Classes
    UrlsUrls
    See also

    PartialInvariantFunctorSyntax and InvariantFunctorSyntax

  70. 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

    Builds an URL from the given path and query string

    Definition Classes
    UrlsUrls
  71. def uuidQueryString: QueryStringParam[UUID]

    Ability to define UUID query string parameters

    Ability to define UUID query string parameters

    Definition Classes
    UrlsUrls
  72. def uuidSegment: Segment[UUID]

    Path segment codec for type UUID

    Path segment codec for type UUID

    Definition Classes
    UrlsUrls
  73. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  74. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  75. 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 Requests toStringFormat[Requests] 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): (Requests, B)
    Implicit
    This member is added by an implicit conversion from Requests toArrowAssoc[Requests] 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 Headers

Inherited from Methods

Inherited from Urls

Inherited from algebra.Requests

Inherited from algebra.Methods

Inherited from algebra.Urls

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromRequests to any2stringadd[Requests]

Inherited by implicit conversion StringFormat fromRequests to StringFormat[Requests]

Inherited by implicit conversion Ensuring fromRequests to Ensuring[Requests]

Inherited by implicit conversion ArrowAssoc fromRequests to ArrowAssoc[Requests]

Types

Types introduced by the algebra

Operations

Operations creating and transforming values

Ungrouped