object Uri extends UriPlatform with Serializable
- Source
- Uri.scala
- Alphabetic
- By Inheritance
- Uri
- Serializable
- Serializable
- UriPlatform
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
- final case class Authority(userInfo: Option[UserInfo] = None, host: Host = RegName("localhost"), port: Option[Int] = None) extends Renderable with Product with Serializable
- type Fragment = String
- sealed trait Host extends Renderable
- final case class Ipv4Address(address: com.comcast.ip4s.Ipv4Address) extends Host with Ordered[Ipv4Address] with Serializable with Product
- final case class Ipv6Address(address: com.comcast.ip4s.Ipv6Address) extends Host with Ordered[Ipv6Address] with Serializable with Product
- final class Path extends Renderable
- final case class RegName(host: CIString) extends Host with Product with Serializable
-
final
class
Scheme extends Ordered[Scheme]
A org.http4s.Uri may begin with a scheme name that refers to a specification for assigning identifiers within that scheme.
A org.http4s.Uri may begin with a scheme name that refers to a specification for assigning identifiers within that scheme.
If the scheme is defined, the URI is absolute. If the scheme is not defined, the URI is a relative reference.
- See also
-
final
case class
UserInfo extends Ordered[UserInfo] with Product with Serializable
The userinfo subcomponent may consist of a user name and, optionally, scheme-specific information about how to gain authorization to access the resource.
The userinfo subcomponent may consist of a user name and, optionally, scheme-specific information about how to gain authorization to access the resource. The user information, if present, is followed by a commercial at-sign ("@") that delimits it from the host.
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
- implicit val catsInstancesForHttp4sUri: Hash[Uri] with Order[Uri] with Show[Uri]
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
def
decode(toDecode: String, charset: java.nio.charset.Charset = StandardCharsets.UTF_8, plusIsSpace: Boolean = false, toSkip: (Char) ⇒ Boolean = Function.const(false)): String
Percent-decodes a string.
Percent-decodes a string.
- toDecode
the string to decode
- charset
the charset of percent-encoded characters
- plusIsSpace
true if
'+'is to be interpreted as a' '- toSkip
a predicate of characters whose percent-encoded form is left percent-encoded. Almost certainly should be left empty.
-
def
encode(toEncode: String, charset: java.nio.charset.Charset = StandardCharsets.UTF_8, spaceIsPlus: Boolean = false, toSkip: (Char) ⇒ Boolean = toSkip): String
Percent-encodes a string.
Percent-encodes a string. Depending on the parameters, this method is appropriate for URI or URL form encoding. Any resulting percent-encodings are normalized to uppercase.
- toEncode
the string to encode
- charset
the charset to use for characters that are percent encoded
- spaceIsPlus
if space is not skipped, determines whether it will be rendreed as a
"+"or a percent-encoding according tocharset.- toSkip
a predicate of characters exempt from encoding. In typical use, this is composed of all Unreserved URI characters and sometimes a subset of Reserved URI characters.
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
fromString(s: String): ParseResult[Uri]
Decodes the String to a Uri using the RFC 3986 uri decoding specification
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def pathEncode(s: String, charset: java.nio.charset.Charset = StandardCharsets.UTF_8): String
-
def
removeDotSegments(path: Path): Path
Remove dot sequences from a Path, per RFC 3986 Sec 5.2.4 Adapted from" https://github.com/Norconex/commons-lang/blob/c83fdeac7a60ac99c8602e0b47056ad77b08f570/norconex-commons-lang/src/main/java/com/norconex/commons/lang/url/URLNormalizer.java#L429
-
def
requestTarget(s: String): ParseResult[Uri]
Decodes the String to a Uri using the RFC 7230 section 5.3 uri decoding specification
-
def
resolve(base: Uri, reference: Uri): Uri
Resolve a relative Uri reference, per RFC 3986 sec 5.2
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
def
unsafeFromString(s: String): Uri
Parses a String to a Uri according to RFC 3986.
Parses a String to a Uri according to RFC 3986. If decoding fails, throws a ParseFailure.
For totality, call #fromString. For compile-time verification of literals, call #uri.
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
- object Authority extends Serializable
- object Host
- object Ipv4Address extends Serializable
- object Ipv6Address extends Serializable
- object Path
- object RegName extends Serializable
- object Scheme
- object UserInfo extends Serializable
Deprecated Value Members
-
macro
def
uri(s: String): Uri
Literal syntax for URIs.
Literal syntax for URIs. Invalid or non-literal arguments are rejected at compile time.
- Definition Classes
- UriPlatform
- Annotations
- @deprecated
- Deprecated
(Since version 0.20) use uri"" string interpolation instead