ktor-http/io.ktor.http/URLBuilder

URLBuilder

class URLBuilder(var protocol: URLProtocol = URLProtocol.HTTP, var host: String = "", var port: Int = DEFAULT_PORT, user: String? = null, password: String? = null, pathSegments: List<String> = emptyList(), parameters: Parameters = Parameters.Empty, fragment: String = "", var trailingQuery: Boolean = false)

A URL builder with all mutable components

Constructors

fun URLBuilder(protocol: URLProtocol = URLProtocol.HTTP, host: String = "", port: Int = DEFAULT_PORT, user: String? = null, password: String? = null, pathSegments: List<String> = emptyList(), parameters: Parameters = Parameters.Empty, fragment: String = "", trailingQuery: Boolean = false)

Types

object Companion

Functions

fun build(): Url

Build a Url instance (everything is copied to a new instance)

fun buildString(): String

Build a URL string

open override fun toString(): String

Properties

encodedFragment

var encodedFragment: String

encodedParameters

var encodedParameters: ParametersBuilder

encodedPassword

var encodedPassword: String?

encodedPathSegments

var encodedPathSegments: List<String>

var encodedUser: String?

var fragment: String

URL fragment (anchor name)

var host: String

name without port (domain)

var parameters: ParametersBuilder

URL query parameters

var password: String?

password part (optional)

var pathSegments: List<String>

URL path without query

port number

var protocol: URLProtocol

URL protocol (scheme)

var trailingQuery: Boolean = false

keep a trailing question character even if there are no query parameters

var user: String?

username part (optional)

Extensions

appendEncodedPathSegments

fun URLBuilder.appendEncodedPathSegments(segments: List<String>): URLBuilder

Adds segments to current encodedPath

fun URLBuilder.appendEncodedPathSegments(vararg components: String): URLBuilder

Adds components to current encodedPath

appendPathSegments

fun URLBuilder.appendPathSegments(segments: List<String>, encodeSlash: Boolean = false): URLBuilder

Adds segments to current encodedPath.

fun URLBuilder.appendPathSegments(vararg components: String, encodeSlash: Boolean = false): URLBuilder

Adds components to current encodedPath

val URLBuilder.authority: String

URLBuilder authority.

fun URLBuilder.clone(): URLBuilder

Create a copy of this builder. Modifications in a copy is not reflected in the original instance and vise-versa.

var URLBuilder.encodedPath: String

val URLBuilder.isAbsolutePath: Boolean

Checks if Url has absolute path.

val URLBuilder.isRelativePath: Boolean

Checks if Url has absolute path.

fun URLBuilder.path(vararg path: String)

Replace components in the current encodedPath. The path components will be escaped, except / character.

fun URLBuilder.~~pathComponents~~(vararg components: String): URLBuilder

fun URLBuilder.~~pathComponents~~(components: List<String>): URLBuilder

fun URLBuilder.set(scheme: String? = null, host: String? = null, port: Int? = null, path: String? = null, block: URLBuilder.() -> Unit = {})

Sets the url parts using the specified scheme, host, port and path. Pass null to keep existing value in the URLBuilder.

fun URLBuilder.takeFrom(urlString: String): URLBuilder

Take url parts from urlString throws URLParserException

fun URLBuilder.takeFrom(url: URLBuilder): URLBuilder

Take components from another url builder

fun URLBuilder.takeFrom(url: Url): URLBuilder

Take components from another url

fun URLBuilder.takeFrom(uri: URI): URLBuilder

Take URI components from uri

fun URLBuilder.takeFrom(url: URL): URLBuilder

Take URL components from url