Uri

Represents a HttpRequest URI.

You have several different options for constructing Uri:

scala> val uri1 = uri"http://google.com"
uri1: hammock.Uri = Uri(Some(http),None,google.com,Map(),None)

scala> val uri2 = Uri(None, None, "path", Map(), None)
uri2: hammock.Uri = Uri(None,None,path,Map(),None)

scala> val uri3 = Uri.fromString("http://google.com")
uri3: Either[String,hammock.Uri] = Right(Uri(Some(http),None,google.com,Map(),None))

scheme: scheme of the uri. For example https
authority: authority of the uri. For example: user:[email protected]:443
path: path of the uri. For example /books/234
query: query string of the uri. For example ?page=3&utm_source=campaign
fragment: fragment of the uri. For example #header1

Linear Supertypes

Serializable, Serializable, Product, Equals, AnyRef, Any

Instance Constructors

new Uri(scheme: Option[Scheme] = None, authority: Option[Authority] = None, path: String = "", query: Map[String, String] = Map(), fragment: Option[Fragment] = None)

scheme
scheme of the uri. For example https
authority
authority of the uri. For example: user:[email protected]:443
path
path of the uri. For example /books/234
query
query string of the uri. For example ?page=3&utm_source=campaign
fragment
fragment of the uri. For example #header1

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
def /(str: String): Uri

Append a string to the path of the Uri
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def ?(ps: NonEmptyList[(String, String)]): Uri

Produces the same result as params but provides syntax as you are writing URI query in browser Usage example:
Produces the same result as params but provides syntax as you are writing URI query in browser Usage example:
```
uri"example.com" ? (("a" -> "b") & ("c" -> "d") & ("e" -> "f"))
```
ps
- parameters
returns
updated Uri
final def asInstanceOf[T0]: T0

Definition Classes
Any
val authority: Option[Authority]

authority of the uri.
authority of the uri. For example: user:[email protected]:443
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
val fragment: Option[Fragment]

fragment of the uri.
fragment of the uri. For example #header1
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def param(key: String, value: String): Uri

Append query parameter to query
Append query parameter to query
key
- parameter name
value
- the value
returns
updated Uri
def params(ps: (String, String)*): Uri

Appends multiple query parameters to query
Appends multiple query parameters to query
ps
- parameters
returns
updated Uri
val path: String

path of the uri.
path of the uri. For example /books/234
val query: Map[String, String]

query string of the uri.
query string of the uri. For example ?page=3&utm_source=campaign
val scheme: Option[Scheme]

scheme of the uri.
scheme of the uri. For example https
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
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( ... )

Related Docs: object Uri | package hammock

case class Uri(scheme: Option[Scheme] = None, authority: Option[Authority] = None, path: String = "", query: Map[String, String] = Map(), fragment: Option[Fragment] = None) extends Product with Serializable

Instance Constructors

new Uri(scheme: Option[Scheme] = None, authority: Option[Authority] = None, path: String = "", query: Map[String, String] = Map(), fragment: Option[Fragment] = None)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def /(str: String): Uri

final def ==(arg0: Any): Boolean

def ?(ps: NonEmptyList[(String, String)]): Uri

final def asInstanceOf[T0]: T0

val authority: Option[Authority]

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

val fragment: Option[Fragment]

final def getClass(): Class[_]

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def param(key: String, value: String): Uri

def params(ps: (String, String)*): Uri

val path: String

val query: Map[String, String]

val scheme: Option[Scheme]

final def synchronized[T0](arg0: ⇒ T0): T0

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped