Packages

final case class URL(path: Path, kind: Location = URL.Location.Relative, queryParams: QueryParams = QueryParams.empty, fragment: Option[Fragment] = None) extends URLPlatformSpecific with QueryOps[URL] with Product with Serializable

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. URL
  2. Serializable
  3. Product
  4. Equals
  5. QueryOps
  6. QueryChecks
  7. QueryGetters
  8. QueryModifier
  9. URLPlatformSpecific
  10. AnyRef
  11. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new URL(path: Path, kind: Location = URL.Location.Relative, queryParams: QueryParams = QueryParams.empty, fragment: Option[Fragment] = None)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def ++(that: URL): URL

    A right-biased way of combining two URLs.

    A right-biased way of combining two URLs. Where it makes sense, information will be merged, but in cases where this does not make sense (e.g. two non-empty fragments), the information from the right URL will be used.

  4. def ++(that: QueryParams): URL

    Combines two collections of query parameters together.

    Combines two collections of query parameters together. If there are duplicate keys, the values from both sides are preserved, in order from left-to-right.

    Definition Classes
    QueryModifier
  5. def /(segment: String): URL
  6. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  7. def absolute(scheme: Scheme, host: String, port: Int): URL
  8. def absolute(host: String): URL
  9. def addLeadingSlash: URL
  10. def addPath(path: String): URL
  11. def addPath(path: Path): URL
  12. def addQueryParam[T](value: T)(implicit schema: Schema[T]): URL
    Definition Classes
    QueryModifier
  13. def addQueryParam[T](key: String, value: T)(implicit schema: Schema[T]): URL
    Definition Classes
    QueryModifier
  14. def addQueryParam(key: String): URL
    Definition Classes
    QueryModifier
  15. def addQueryParam(key: String, value: String): URL

    Adds the specified key/value pair to the query parameters.

    Adds the specified key/value pair to the query parameters.

    Definition Classes
    QueryModifier
  16. def addQueryParams(queryParams: QueryParams): URL
  17. def addQueryParams(queryParams: Iterable[(String, String)]): URL
    Definition Classes
    QueryModifier
  18. def addQueryParams(values: String): URL
    Definition Classes
    QueryModifier
  19. def addQueryParams(key: String, value: Chunk[String]): URL

    Adds the specified key/value pairs to the query parameters.

    Adds the specified key/value pairs to the query parameters.

    Definition Classes
    QueryModifier
  20. def addTrailingSlash: URL
  21. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  22. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  23. def dropLeadingSlash: URL
  24. def dropTrailingSlash: URL
  25. def encode: String
  26. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. def equals(that: Any): Boolean
    Definition Classes
    URL → Equals → AnyRef → Any
  28. val fragment: Option[Fragment]
  29. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  30. def hasQueryParam(name: CharSequence): Boolean
    Definition Classes
    QueryChecks
  31. def hashCode(): Int
    Definition Classes
    URL → AnyRef → Any
  32. def host(host: String): URL
  33. def host: Option[String]
  34. def hostPort: Option[String]

    returns

    the location, the host name and the port. The port part is omitted if is the default port for the protocol.

  35. def isAbsolute: Boolean
  36. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  37. def isRelative: Boolean
  38. val kind: Location
  39. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  40. def normalize: URL
  41. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  42. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  43. def path(path: String): URL
  44. def path(path: Path): URL
  45. val path: Path
  46. def port: Option[Int]
  47. def port(port: Int): URL
  48. def portIfNotDefault: Option[Int]
  49. def portOrDefault: Option[Int]
  50. def productElementNames: Iterator[String]
    Definition Classes
    Product
  51. def query[T](implicit schema: Schema[T]): Either[QueryParamError, T]

    Retrieves query parameters as a value of the specified type.

    Retrieves query parameters as a value of the specified type. The type must have a schema and be a case class and all fields must be query parameters. So fields must be of primitive types (e.g. Int, String, UUID, Instant etc.), a case class with a single field or a collection of either of these. Query parameters are selected by field names.

    Definition Classes
    QueryGetters
  52. def query[T](key: String)(implicit schema: Schema[T]): Either[QueryParamError, T]

    Retrieves the query parameter with the specified name as a value of the specified type.

    Retrieves the query parameter with the specified name as a value of the specified type. The type must have a schema and can be a primitive type (e.g. Int, String, UUID, Instant etc.), a case class with a single field or a collection of either of these.

    Definition Classes
    QueryGetters
  53. def queryOrElse[T](default: => T)(implicit schema: Schema[T]): T
    Definition Classes
    QueryGetters
  54. def queryOrElse[T](key: String, default: => T)(implicit schema: Schema[T]): T
    Definition Classes
    QueryGetters
  55. def queryParam(key: String): Option[String]

    Retrieves the first query parameter value having the specified name.

    Retrieves the first query parameter value having the specified name.

    Definition Classes
    QueryGetters
  56. def queryParamOrElse(key: String, default: => String): String

    Retrieves the first query parameter value having the specified name, or else uses the default value.

    Retrieves the first query parameter value having the specified name, or else uses the default value.

    Definition Classes
    QueryGetters
  57. def queryParameters: QueryParams
    Definition Classes
    URL → QueryGetters
  58. def queryParams(key: String): Chunk[String]

    Retrieves all query parameter values having the specified name.

    Retrieves all query parameter values having the specified name.

    Definition Classes
    QueryGetters
  59. val queryParams: QueryParams
  60. def queryParamsOrElse(key: String, default: => Iterable[String]): Chunk[String]

    Retrieves all query parameter values having the specified name, or else uses the default iterable.

    Retrieves all query parameter values having the specified name, or else uses the default iterable.

    Definition Classes
    QueryGetters
  61. def queryZIO[T](key: String)(implicit schema: Schema[T]): IO[QueryParamError, T]

    Retrieves all typed query parameter values having the specified name as ZIO

    Retrieves all typed query parameter values having the specified name as ZIO

    Definition Classes
    QueryGetters
  62. def relative: URL
  63. def removeQueryParam(key: String): URL

    Removes the specified key from the query parameters.

    Removes the specified key from the query parameters.

    Definition Classes
    QueryModifier
  64. def removeQueryParams(keys: Iterable[String]): URL

    Removes the specified keys from the query parameters.

    Removes the specified keys from the query parameters.

    Definition Classes
    QueryModifier
  65. def resolve(reference: URL): Either[String, URL]

    RFC 3986 § 5.2 Relative Resolution

    RFC 3986 § 5.2 Relative Resolution

    reference

    the URL to resolve relative to this base URL

    returns

    the target URL

  66. def scheme(scheme: Scheme): URL
  67. def scheme: Option[Scheme]
  68. def setQueryParams(queryParams: (String, Chunk[String])*): URL
    Definition Classes
    QueryModifier
  69. def setQueryParams(queryParams: Map[String, Chunk[String]]): URL
    Definition Classes
    QueryModifier
  70. def setQueryParams(values: String): URL
    Definition Classes
    QueryModifier
  71. def setQueryParams(values: QueryParams): URL
    Definition Classes
    QueryModifier
  72. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  73. def toJavaURI: URI

    Returns a new java.net.URI representing this URL.

  74. def toJavaURL: Option[java.net.URL]

    Returns a new java.net.URL only if this URL represents an absolute location.

    Returns a new java.net.URL only if this URL represents an absolute location.

    Definition Classes
    URLPlatformSpecific
  75. def toString(): String
    Definition Classes
    URL → AnyRef → Any
  76. def updateQueryParams(f: (QueryParams) => QueryParams): URL
    Definition Classes
    URL → QueryModifier
  77. def valueCount(name: CharSequence): Int
    Definition Classes
    QueryChecks
  78. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  79. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  80. 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

    (Since version 9)

  2. def queryParamTo[T](key: String)(implicit codec: TextCodec[T]): Either[QueryParamsError, T]

    Retrieves the first typed query parameter value having the specified name.

    Retrieves the first typed query parameter value having the specified name.

    Definition Classes
    QueryGetters
    Annotations
    @deprecated
    Deprecated

    (Since version 3.1.0) Use query(key)[T]

  3. def queryParamToOrElse[T](key: String, default: => T)(implicit codec: TextCodec[T]): T

    Retrieves the first typed query parameter value having the specified name, or else uses the default value.

    Retrieves the first typed query parameter value having the specified name, or else uses the default value.

    Definition Classes
    QueryGetters
    Annotations
    @deprecated
    Deprecated

    (Since version 3.1.0) Use queryParamOrElse(key, default)

  4. def queryParamToZIO[T](key: String)(implicit codec: TextCodec[T]): IO[QueryParamsError, T]

    Retrieves the first typed query parameter value having the specified name as ZIO.

    Retrieves the first typed query parameter value having the specified name as ZIO.

    Definition Classes
    QueryGetters
    Annotations
    @deprecated
    Deprecated

    (Since version 3.1.0) Use queryZIO(key)[T]

  5. def queryParamsTo[T](key: String)(implicit codec: TextCodec[T]): Either[QueryParamsError, Chunk[T]]

    Retrieves all typed query parameter values having the specified name.

    Retrieves all typed query parameter values having the specified name.

    Definition Classes
    QueryGetters
    Annotations
    @deprecated
    Deprecated

    (Since version 3.1.0) Use query(key)[Chunk[T]

  6. def queryParamsToOrElse[T](key: String, default: => Iterable[T])(implicit codec: TextCodec[T]): Chunk[T]

    Retrieves all query parameter values having the specified name, or else uses the default iterable.

    Retrieves all query parameter values having the specified name, or else uses the default iterable.

    Definition Classes
    QueryGetters
    Annotations
    @deprecated
    Deprecated

    (Since version 3.1.0) Use queryParamsOrElse(key, default)

  7. def queryParamsToZIO[T](key: String)(implicit codec: TextCodec[T]): IO[QueryParamsError, Chunk[T]]

    Retrieves all typed query parameter values having the specified name as ZIO.

    Retrieves all typed query parameter values having the specified name as ZIO.

    Definition Classes
    QueryGetters
    Annotations
    @deprecated
    Deprecated

    (Since version 3.1.0) Use queryZIO(key)[Chunk[T]

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from QueryOps[URL]

Inherited from QueryChecks[URL]

Inherited from QueryGetters[URL]

Inherited from QueryModifier[URL]

Inherited from URLPlatformSpecific

Inherited from AnyRef

Inherited from Any

Ungrouped