The hu.dwim.uri Reference Manual

Next: , Previous: , Up: (dir)   [Contents][Index]

The hu.dwim.uri Reference Manual

This is the hu.dwim.uri Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Aug 15 04:50:05 2022 GMT+0.

Table of Contents


1 Introduction

http://dwim.hu/project/hu.dwim.util


2 Systems

The main system appears first, followed by any subsystem dependency.


Previous: , Up: Systems   [Contents][Index]

2.1 hu.dwim.uri

Authors

Tamás Borbély <tomi.borbely@gmail.com>
Attila Lendvai <attila.lendvai@gmail.com>
Levente Mészáros <levente.meszaros@gmail.com>

License

BSD or Bugroff

Defsystem Dependency

hu.dwim.asdf (system).

Dependencies
  • babel (system).
  • cl-ppcre (system).
  • hu.dwim.util (system).
  • iolib/sockets (system).
Source

hu.dwim.uri.asd.

Child Component

source (module).


3 Modules

Modules are listed depth-first from the system components tree.


Previous: , Up: Modules   [Contents][Index]

3.1 hu.dwim.uri/source

Source

hu.dwim.uri.asd.

Parent Component

hu.dwim.uri (system).

Child Components

4 Files

Files are sorted by type and then listed depth-first from the systems components trees.


Previous: , Up: Files   [Contents][Index]

4.1 Lisp


4.1.1 hu.dwim.uri/hu.dwim.uri.asd

Source

hu.dwim.uri.asd.

Parent Component

hu.dwim.uri (system).

ASDF Systems

hu.dwim.uri.


4.1.2 hu.dwim.uri/source/package.lisp

Source

hu.dwim.uri.asd.

Parent Component

source (module).

Packages

hu.dwim.uri.


4.1.3 hu.dwim.uri/source/uri.lisp

Dependency

package.lisp (file).

Source

hu.dwim.uri.asd.

Parent Component

source (module).

Public Interface
Internals

5 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

5.1 hu.dwim.uri

Source

package.lisp.

Use List
  • hu.dwim.asdf.
  • hu.dwim.common.
  • hu.dwim.def.
  • hu.dwim.syntax-sugar.
  • hu.dwim.util.
Public Interface
Internals

6 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


Next: , Previous: , Up: Definitions   [Contents][Index]

6.1 Public Interface


6.1.1 Ordinary functions

Function: add-query-parameter (uri name value)
Package

hu.dwim.uri.

Source

uri.lisp.

Function: append-path (uri path)
Package

hu.dwim.uri.

Source

uri.lisp.

Function: append-to-last-path-element (uri string)
Package

hu.dwim.uri.

Source

uri.lisp.

Function: clone-uri (uri &key scheme host port path query fragment)

Clone URI with any provided components fully overriding its components (e.g. no path merging).

Package

hu.dwim.uri.

Source

uri.lisp.

Function: copy-all-query-parameters (from to)
Package

hu.dwim.uri.

Source

uri.lisp.

Function: copy-query-parameters (from to &rest parameter-names)
Package

hu.dwim.uri.

Source

uri.lisp.

Function: delete-all-query-parameters (uri)
Package

hu.dwim.uri.

Source

uri.lisp.

Function: delete-query-parameters (uri &rest names)
Package

hu.dwim.uri.

Source

uri.lisp.

Function: ensure-parsed-uri (uri)
Package

hu.dwim.uri.

Source

uri.lisp.

Function: make-uri (&key scheme host port path path-had-leading-slash? query fragment)
Package

hu.dwim.uri.

Source

uri.lisp.

Function: parse-query-parameters (param-string &key initial-parameters sideffect-initial-parameters)

Parse PARAM-STRING into an alist. The value part will be a list if the given parameter was found multiple times.

Package

hu.dwim.uri.

Source

uri.lisp.

Function: parse-uri (uri-string &key lazy)

Parse a percent-encoded URI string into an object of type URI.

Package

hu.dwim.uri.

Source

uri.lisp.

Function: percent-encoding/decode (input)

URI unescape based on http://www.ietf.org/rfc/rfc2396.txt

Package

hu.dwim.uri.

Source

uri.lisp.

Function: percent-encoding/encode (string)

Escapes all non alphanumeric characters in STRING following the URI convention. Returns a fresh string.

Package

hu.dwim.uri.

Source

uri.lisp.

Function: prepend-path (uri path)
Package

hu.dwim.uri.

Source

uri.lisp.

Function: print-uri-to-string (uri &key escape extra-parameters)
Package

hu.dwim.uri.

Source

uri.lisp.

Function: query-parameter-value (uri name)
Package

hu.dwim.uri.

Source

uri.lisp.

Function: (setf query-parameter-value) (uri name)
Package

hu.dwim.uri.

Source

uri.lisp.

Function: split-path (path-string)

Returns (values list-of-path-elements ends-with-slash?)

Package

hu.dwim.uri.

Source

uri.lisp.

Function: uri-parse-error (message &rest args)
Package

hu.dwim.uri.

Source

uri.lisp.


6.1.2 Generic functions

Generic Reader: fragment-of (object)
Package

hu.dwim.uri.

Methods
Reader Method: fragment-of ((uri uri))

automatically generated reader method

Source

uri.lisp.

Target Slot

fragment.

Generic Writer: (setf fragment-of) (object)
Package

hu.dwim.uri.

Methods
Writer Method: (setf fragment-of) ((uri uri))

automatically generated writer method

Source

uri.lisp.

Target Slot

fragment.

Generic Reader: host-of (object)
Package

hu.dwim.uri.

Methods
Reader Method: host-of ((uri uri))

automatically generated reader method

Source

uri.lisp.

Target Slot

host.

Generic Writer: (setf host-of) (object)
Package

hu.dwim.uri.

Methods
Writer Method: (setf host-of) ((uri uri))

automatically generated writer method

Source

uri.lisp.

Target Slot

host.

Generic Reader: path-had-leading-slash? (object)
Package

hu.dwim.uri.

Methods
Reader Method: path-had-leading-slash? ((uri uri))

automatically generated reader method

Source

uri.lisp.

Target Slot

path-had-leading-slash?.

Generic Writer: (setf path-had-leading-slash?) (object)
Package

hu.dwim.uri.

Methods
Writer Method: (setf path-had-leading-slash?) ((uri uri))

automatically generated writer method

Source

uri.lisp.

Target Slot

path-had-leading-slash?.

Generic Reader: path-of (object)
Package

hu.dwim.uri.

Methods
Reader Method: path-of ((uri uri))

automatically generated reader method

Source

uri.lisp.

Target Slot

path.

Generic Writer: (setf path-of) (object)
Package

hu.dwim.uri.

Methods
Writer Method: (setf path-of) ((uri uri))

automatically generated writer method

Source

uri.lisp.

Target Slot

path.

Generic Reader: port-of (object)
Package

hu.dwim.uri.

Methods
Reader Method: port-of ((uri uri))

automatically generated reader method

Source

uri.lisp.

Target Slot

port.

Generic Writer: (setf port-of) (object)
Package

hu.dwim.uri.

Methods
Writer Method: (setf port-of) ((uri uri))

automatically generated writer method

Source

uri.lisp.

Target Slot

port.

Generic Function: query-parameters-of (object)
Package

hu.dwim.uri.

Methods
Reader Method: query-parameters-of :before ((self uri))
Source

uri.lisp.

Target Slot

query-parameters.

Method: query-parameters-of ((uri uri))

A cache for PARSE-QUERY-PARAMETERS.

Source

uri.lisp.

Generic Writer: (setf query-parameters-of) (object)
Package

hu.dwim.uri.

Methods
Writer Method: (setf query-parameters-of) ((uri uri))

A cache for PARSE-QUERY-PARAMETERS.

Source

uri.lisp.

Target Slot

query-parameters.

Generic Reader: scheme-of (object)
Package

hu.dwim.uri.

Methods
Reader Method: scheme-of ((uri uri))

automatically generated reader method

Source

uri.lisp.

Target Slot

scheme.

Generic Writer: (setf scheme-of) (object)
Package

hu.dwim.uri.

Methods
Writer Method: (setf scheme-of) ((uri uri))

automatically generated writer method

Source

uri.lisp.

Target Slot

scheme.


6.1.3 Standalone methods

Method: make-load-form ((self uri) &optional env)
Source

uri.lisp.

Method: print-object ((-self- uri) stream0)
Source

uri.lisp.

Writer Method: (setf query-of) ((uri uri))

automatically generated writer method

Package

hu.dwim.util.

Source

uri.lisp.

Target Slot

query.

Reader Method: query-of ((uri uri))

automatically generated reader method

Package

hu.dwim.util.

Source

uri.lisp.

Target Slot

query.


6.1.4 Conditions

Condition: uri-parse-error
Package

hu.dwim.uri.

Source

uri.lisp.

Direct superclasses
  • nested-condition.
  • simple-parse-error.
Direct methods
Direct slots
Slot: uri-string
Initform

(quote hu.dwim.uri::*uri-string*)

Initargs

:uri-string

Readers

uri-string-of.

Writers

(setf uri-string-of).


Previous: , Up: Public Interface   [Contents][Index]

6.1.5 Classes

Class: uri
Package

hu.dwim.uri.

Source

uri.lisp.

Direct methods
Direct slots
Slot: scheme
Type

(or null string)

Initargs

:scheme

Readers

scheme-of.

Writers

(setf scheme-of).

Slot: host
Package

hu.dwim.util.

Type

(or null string)

Initargs

:host

Readers

host-of.

Writers

(setf host-of).

Slot: port
Package

hu.dwim.util.

Type

(or null string)

Initargs

:port

Readers

port-of.

Writers

(setf port-of).

Slot: path
Type

(or null string)

Initargs

:path

Readers

path-of.

Writers

(setf path-of).

Slot: path-had-leading-slash?
Type

boolean

Initargs

:path-had-leading-slash?

Readers

path-had-leading-slash?.

Writers

(setf path-had-leading-slash?).

Slot: query
Package

hu.dwim.util.

Type

(or null string)

Initargs

:query

Readers

query-of.

Writers

(setf query-of).

Slot: query-parameters

A cache for PARSE-QUERY-PARAMETERS.

Type

list

Initargs

:query-parameters

Readers

query-parameters-of.

Writers

(setf query-parameters-of).

Slot: fragment
Initargs

:fragment

Readers

fragment-of.

Writers

(setf fragment-of).


6.2 Internals


Next: , Previous: , Up: Internals   [Contents][Index]

6.2.1 Constants

Constant: +allowed-characters+
Package

hu.dwim.uri.

Source

uri.lisp.

Constant: +allowed-characters/scheme+
Package

hu.dwim.uri.

Source

uri.lisp.

Constant: +alphanumeric-characters+
Package

hu.dwim.uri.

Source

uri.lisp.

Constant: +character-ok-table+
Package

hu.dwim.uri.

Source

uri.lisp.

Constant: +character-ok-table/scheme+
Package

hu.dwim.uri.

Source

uri.lisp.

Constant: +delimiter-characters+
Package

hu.dwim.uri.

Source

uri.lisp.


Next: , Previous: , Up: Internals   [Contents][Index]

6.2.2 Special variables

Special Variable: *uri-string*

Holds the uri string currently being parsed.

Package

hu.dwim.uri.

Source

uri.lisp.


6.2.3 Macros

Macro: record-query-parameter (param params)
Package

hu.dwim.uri.

Source

uri.lisp.

Macro: with-resignalled-errors (&body body)
Package

hu.dwim.uri.

Source

uri.lisp.


Next: , Previous: , Up: Internals   [Contents][Index]

6.2.4 Ordinary functions

Function: is-string-ok? (string ok-table)
Package

hu.dwim.uri.

Source

uri.lisp.

Function: print-uri-to-string/sans-query (uri &key escape)
Package

hu.dwim.uri.

Source

uri.lisp.

Function: to-character-ok-table (string &key initial-element)
Package

hu.dwim.uri.

Source

uri.lisp.

Function: uri-parse-error-p (object)
Package

hu.dwim.uri.

Source

uri.lisp.

Function: uri-parse-error/nested (nested-error message &rest args)
Package

hu.dwim.uri.

Source

uri.lisp.

Function: urip (object)
Package

hu.dwim.uri.

Source

uri.lisp.

Function: write-in-percent-encoding (string stream)
Package

hu.dwim.uri.

Source

uri.lisp.

Function: write-query-parameters (parameters stream &key escape)
Package

hu.dwim.uri.

Source

uri.lisp.

Function: write-uri (uri stream &key escape extra-parameters)
Package

hu.dwim.uri.

Source

uri.lisp.

Function: write-uri/sans-query (uri stream &key escape)

Write URI to STREAM, only write scheme, host and path.

Package

hu.dwim.uri.

Source

uri.lisp.


6.2.5 Generic functions

Generic Reader: uri-string-of (condition)
Generic Writer: (setf uri-string-of) (condition)
Package

hu.dwim.uri.

Methods
Reader Method: uri-string-of ((condition uri-parse-error))
Writer Method: (setf uri-string-of) ((condition uri-parse-error))
Source

uri.lisp.

Target Slot

uri-string.


Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts


Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   (  
A   C   D   E   F   G   H   I   M   P   Q   R   S   T   U   W  
Index Entry  Section

(
(setf fragment-of): Public generic functions
(setf fragment-of): Public generic functions
(setf host-of): Public generic functions
(setf host-of): Public generic functions
(setf path-had-leading-slash?): Public generic functions
(setf path-had-leading-slash?): Public generic functions
(setf path-of): Public generic functions
(setf path-of): Public generic functions
(setf port-of): Public generic functions
(setf port-of): Public generic functions
(setf query-of): Public standalone methods
(setf query-parameter-value): Public ordinary functions
(setf query-parameters-of): Public generic functions
(setf query-parameters-of): Public generic functions
(setf scheme-of): Public generic functions
(setf scheme-of): Public generic functions
(setf uri-string-of): Private generic functions
(setf uri-string-of): Private generic functions

A
add-query-parameter: Public ordinary functions
append-path: Public ordinary functions
append-to-last-path-element: Public ordinary functions

C
clone-uri: Public ordinary functions
copy-all-query-parameters: Public ordinary functions
copy-query-parameters: Public ordinary functions

D
delete-all-query-parameters: Public ordinary functions
delete-query-parameters: Public ordinary functions

E
ensure-parsed-uri: Public ordinary functions

F
fragment-of: Public generic functions
fragment-of: Public generic functions
Function, (setf query-parameter-value): Public ordinary functions
Function, add-query-parameter: Public ordinary functions
Function, append-path: Public ordinary functions
Function, append-to-last-path-element: Public ordinary functions
Function, clone-uri: Public ordinary functions
Function, copy-all-query-parameters: Public ordinary functions
Function, copy-query-parameters: Public ordinary functions
Function, delete-all-query-parameters: Public ordinary functions
Function, delete-query-parameters: Public ordinary functions
Function, ensure-parsed-uri: Public ordinary functions
Function, is-string-ok?: Private ordinary functions
Function, make-uri: Public ordinary functions
Function, parse-query-parameters: Public ordinary functions
Function, parse-uri: Public ordinary functions
Function, percent-encoding/decode: Public ordinary functions
Function, percent-encoding/encode: Public ordinary functions
Function, prepend-path: Public ordinary functions
Function, print-uri-to-string: Public ordinary functions
Function, print-uri-to-string/sans-query: Private ordinary functions
Function, query-parameter-value: Public ordinary functions
Function, split-path: Public ordinary functions
Function, to-character-ok-table: Private ordinary functions
Function, uri-parse-error: Public ordinary functions
Function, uri-parse-error-p: Private ordinary functions
Function, uri-parse-error/nested: Private ordinary functions
Function, urip: Private ordinary functions
Function, write-in-percent-encoding: Private ordinary functions
Function, write-query-parameters: Private ordinary functions
Function, write-uri: Private ordinary functions
Function, write-uri/sans-query: Private ordinary functions

G
Generic Function, (setf fragment-of): Public generic functions
Generic Function, (setf host-of): Public generic functions
Generic Function, (setf path-had-leading-slash?): Public generic functions
Generic Function, (setf path-of): Public generic functions
Generic Function, (setf port-of): Public generic functions
Generic Function, (setf query-parameters-of): Public generic functions
Generic Function, (setf scheme-of): Public generic functions
Generic Function, (setf uri-string-of): Private generic functions
Generic Function, fragment-of: Public generic functions
Generic Function, host-of: Public generic functions
Generic Function, path-had-leading-slash?: Public generic functions
Generic Function, path-of: Public generic functions
Generic Function, port-of: Public generic functions
Generic Function, query-parameters-of: Public generic functions
Generic Function, scheme-of: Public generic functions
Generic Function, uri-string-of: Private generic functions

H
host-of: Public generic functions
host-of: Public generic functions

I
is-string-ok?: Private ordinary functions

M
Macro, record-query-parameter: Private macros
Macro, with-resignalled-errors: Private macros
make-load-form: Public standalone methods
make-uri: Public ordinary functions
Method, (setf fragment-of): Public generic functions
Method, (setf host-of): Public generic functions
Method, (setf path-had-leading-slash?): Public generic functions
Method, (setf path-of): Public generic functions
Method, (setf port-of): Public generic functions
Method, (setf query-of): Public standalone methods
Method, (setf query-parameters-of): Public generic functions
Method, (setf scheme-of): Public generic functions
Method, (setf uri-string-of): Private generic functions
Method, fragment-of: Public generic functions
Method, host-of: Public generic functions
Method, make-load-form: Public standalone methods
Method, path-had-leading-slash?: Public generic functions
Method, path-of: Public generic functions
Method, port-of: Public generic functions
Method, print-object: Public standalone methods
Method, query-of: Public standalone methods
Method, query-parameters-of: Public generic functions
Method, query-parameters-of: Public generic functions
Method, scheme-of: Public generic functions
Method, uri-string-of: Private generic functions

P
parse-query-parameters: Public ordinary functions
parse-uri: Public ordinary functions
path-had-leading-slash?: Public generic functions
path-had-leading-slash?: Public generic functions
path-of: Public generic functions
path-of: Public generic functions
percent-encoding/decode: Public ordinary functions
percent-encoding/encode: Public ordinary functions
port-of: Public generic functions
port-of: Public generic functions
prepend-path: Public ordinary functions
print-object: Public standalone methods
print-uri-to-string: Public ordinary functions
print-uri-to-string/sans-query: Private ordinary functions

Q
query-of: Public standalone methods
query-parameter-value: Public ordinary functions
query-parameters-of: Public generic functions
query-parameters-of: Public generic functions
query-parameters-of: Public generic functions

R
record-query-parameter: Private macros

S
scheme-of: Public generic functions
scheme-of: Public generic functions
split-path: Public ordinary functions

T
to-character-ok-table: Private ordinary functions

U
uri-parse-error: Public ordinary functions
uri-parse-error-p: Private ordinary functions
uri-parse-error/nested: Private ordinary functions
uri-string-of: Private generic functions
uri-string-of: Private generic functions
urip: Private ordinary functions

W
with-resignalled-errors: Private macros
write-in-percent-encoding: Private ordinary functions
write-query-parameters: Private ordinary functions
write-uri: Private ordinary functions
write-uri/sans-query: Private ordinary functions

Jump to:   (  
A   C   D   E   F   G   H   I   M   P   Q   R   S   T   U   W