This is the purl Reference Manual, version 1.2, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Jul 13 21:37:47 2025 GMT+0.
The main system appears first, followed by any subsystem dependency.
purlParse and print URLs as described in RFC 1738.
Max Rottenkolber <max@mr.gy>
GNU AGPL
1.2
maxpc (system).
percent-encoding (system).
uiop (system).
package.lisp (file).
grammar.lisp (file).
purl.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
purl/grammar.lisppackage.lisp (file).
purl (system).
=common-address (function).
=common-address-p (function).
=credentials (function).
=host (function).
=password (function).
=path (function).
=port (function).
=scheme (function).
=url (function).
=user (function).
purl/purl.lisppackage.lisp (file).
grammar.lisp (file).
purl (system).
make-url (function).
print-object (method).
url (function).
url (structure).
url-address (function).
url-decode (function).
url-encode (function).
url-host (function).
url-p (function).
url-password (function).
url-path (function).
url-port (function).
url-scheme (function).
url-string (function).
url-user (function).
url= (function).
common-address (structure).
common-address-host (reader).
(setf common-address-host) (writer).
common-address-p (function).
common-address-password (reader).
(setf common-address-password) (writer).
common-address-path (reader).
(setf common-address-path) (writer).
common-address-port (reader).
(setf common-address-port) (writer).
common-address-string (function).
common-address-user (reader).
(setf common-address-user) (writer).
copy-common-address (function).
copy-url (function).
encode-pathname (function).
make-common-address (function).
make-url% (function).
malformed-url (condition).
parse-common-address (function).
parse-url (function).
pathname-url-path (function).
url-address% (reader).
(setf url-address%) (writer).
url-p% (function).
url-scheme% (reader).
(setf url-scheme%) (writer).
url-scheme-string (function).
Packages are listed by definition order.
purlParse and print _Uniform Resource Locators_ as defined in
[RFC 1738](http://tools.ietf.org/html/rfc1738).
< URL Designators
A _url designator_ is a value accepted by the {url} _function_.
E.g. a _url_, a _string_ or a _pathname_.
>
common-lisp.
maxpc.
maxpc.char.
maxpc.digit.
percent-encoding.
uiop/driver.
make-url (function).
url (function).
url (structure).
url-address (function).
url-decode (function).
url-encode (function).
url-host (function).
url-p (function).
url-password (function).
url-path (function).
url-port (function).
url-scheme (function).
url-string (function).
url-user (function).
url= (function).
=common-address (function).
=common-address-p (function).
=credentials (function).
=host (function).
=password (function).
=path (function).
=port (function).
=scheme (function).
=url (function).
=user (function).
common-address (structure).
common-address-host (reader).
(setf common-address-host) (writer).
common-address-p (function).
common-address-password (reader).
(setf common-address-password) (writer).
common-address-path (reader).
(setf common-address-path) (writer).
common-address-port (reader).
(setf common-address-port) (writer).
common-address-string (function).
common-address-user (reader).
(setf common-address-user) (writer).
copy-common-address (function).
copy-url (function).
encode-pathname (function).
make-common-address (function).
make-url% (function).
malformed-url (condition).
parse-common-address (function).
parse-url (function).
pathname-url-path (function).
url-address% (reader).
(setf url-address%) (writer).
url-p% (function).
url-scheme% (reader).
(setf url-scheme%) (writer).
url-scheme-string (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
*Arguments and Values:*
_scheme_—a _keyword_ denoting a URL scheme.
_address_—a _string_ denoting a URL address for _scheme_ or {nil}. The
default is {nil}.
_user_, _password_, _host_—_strings_ denoting a user name, password or
hostname respectively or {nil}. The default is {nil}.
_path_—a _string_ or a _pathname_.
_port_—a positive _integer_ denoting a port number or {nil} . The
default is {nil}.
*Description*:
{make-url} returns a fresh _url_ of _scheme_. _Address_ is used as the
URL’s address if supplied. Otherwise the URL’s address will use
_Common Internet Scheme Syntax_¹ and its address is composed of the
_user_, _password_, _host_, _port_ and _path_ components.
*See Also:*
+ 1. [Common Internet Scheme Syntax](http://tools.ietf.org/html/rfc1738#section-3.1)
*Arguments and Values:*
_urlspec_—a _string_, a _pathname_ or a _url_.
*Description*:
{url} returns the _url_ denoted by _urlspec_. When _urlspec_ is a
string, {url} will attempt to parse _urlspec_ as a URL. When _urlspec_
is a _pathname_, {url} will return an equivalent _url_ using the
{:file} scheme.
*Exceptional Situations:*
An error of _type_ {malformed-url} is signaled when _urlspec_ is a
_string_ and can not be parsed as a URL.
An error of _type_ {type-error} is signaled when _urlspec_ is a _pathname_ using a host component which is not a defined logical host.
*Arguments and Values:*
_url_—a _url_ designator.
*Description*:
{url-address} returns a _string_ denoting the address part of _url_.
*Arguments and Values:*
_string_—a _string.
*Description*:
{url-decode} decodes encoded _string_ using _Percent-Encoding_¹.
*See Also:*
+ 1. [Percent-Encoding](http://tools.ietf.org/html/rfc3986#section-2.1)
*Arguments and Values:*
_string_—a _string.
*Description*:
{url-encode} encodes _string_ using _Percent-Encoding_¹.
*See Also:*
+ 1. [Percent-Encoding](http://tools.ietf.org/html/rfc3986#section-2.1)
*Arguments and Values:*
_url_—a _url_ designator.
*Description*:
{url-host} returns a _string_ denoting the host part of _url_.
*Arguments and Values:*
_object_—an _object_.
*Description*:
{url-p} returns _true_ if _object_ is of _type_ {url}; otherwise, returns _false_.
*Arguments and Values:*
_url_—a _url_ designator.
*Description*:
{url-password} returns a _string_ denoting the password part of _url_.
*Arguments and Values:*
_url_—a _url_ designator.
*Description*:
{url-path} returns a _string_ denoting the path part of _url_.
*Arguments and Values:*
_url_—a _url_ designator.
*Description*:
{url-port} returns a non-negative _integer_ denoting the port part of _url_.
*Arguments and Values:*
_url_—a _url_ designator.
*Description*:
{url-scheme} returns a _keyword_ denoting the scheme part of _url_.
*Arguments and Values:*
_url_—a _url_ designator.
*Description*:
{url-string} returns a _string_ representation of _url_.
*Arguments and Values:*
_url_—a _url_ designator.
*Description*:
{url-user} returns a _string_ denoting the user part of _url_.
*Arguments and Values:*
_url1_, _url2_—_urls_.
*Description*:
{url=} returns _true_ if _url1_ and _url2_ are equal; otherwise, returns _false_.
A _url_ is a structured _object_ which represents a _Uniform Resource Locator_ (URL).
Return string for COMMON-ADDRESS.
Parse COMMON-ADDRESS structure from URL-ADDRESS.
Common address structure for IP-based protocols.
purl.
structure-object.
(or string null)
(or string null)
(or string null)
(or unsigned-byte null)
(or string null)
| Jump to: | (
=
C E F M P U |
|---|
| Jump to: | (
=
C E F M P U |
|---|
| Jump to: | A H M P S U |
|---|
| Jump to: | A H M P S U |
|---|
| Jump to: | C F G M P S U |
|---|
| Jump to: | C F G M P S U |
|---|