This library provides a WHATWG-specifications compliant URL parser in pure Nim, that does not compromise on correctness nor speed.

Basic Usage

Parse URL with Exceptions

import pkg/url

let a = parseURL("https://google.com")
echo a.hostname

try:
  let badUrl = parseURL("")
except url.URLParsingError as exc:
  echo exc.msg

Parse URL with Results

import pkg/[results, url]

let a = tryParseURL("https://google.com")
assert(isOk(a))

let badUrl = tryParseURL("")
assert(not isOk(a))

Imports

parser, types, url

Types

URLParsingError = object of ValueError

The base exception from which all URL parsing failures derive from. This can be used as a blanket "catch-all" exception to catch all parsing errors.

Currently, specialized exceptions do not exist. They will be added in the future.

Procs

func parseURL(source: Input; baseUrl: Option[URL] = none(URL)): URL {. ...raises: [URLParsingError, ValueError, Exception].}: Given a URL string (source), parse it using the WHATWG URL specifications parsing algorithm, to try and produce a valid URL representation.

This routine returns a URL upon a successful parse. If parsing is unsuccessful, a URLParsingError is thrown, which can be caught by the programmer.

Algorithm: https://url.spec.whatwg.org/#url-parsing
func tryParseURL(source: Input; baseUrl: Option[URL] = none(URL)): Result[URL, ParseError]: Given a URL string (source), parse it using the WHATWG URL specifications parsing algorithm, to try and produce a valid URL representation.

This routine returns a Result[URL, ParseError]. When parsing is successful, a URL can be obtained from this Result. Otherwise, the ParseError can be obtained to understand why the parse was unsuccessful.

Algorithm: https://url.spec.whatwg.org/#url-parsing