The restas.file-publisher Reference Manual

This is the restas.file-publisher Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 06:47:02 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 restas.file-publisher

A restas module which can publish static files

Author

Kevin Lynx <>

License

MIT

Version

0.1

Dependencies
  • restas (system).
  • cl-fad (system).
Source

restas.file-publisher.asd.

Child Component

file-publisher.lisp (file).


3 Files

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


3.1 Lisp


3.1.1 restas.file-publisher/restas.file-publisher.asd

Source

restas.file-publisher.asd.

Parent Component

restas.file-publisher (system).

ASDF Systems

restas.file-publisher.


3.1.2 restas.file-publisher/file-publisher.lisp

Source

restas.file-publisher.asd.

Parent Component

restas.file-publisher (system).

Packages

restas.file-publisher.

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 restas.file-publisher

Source

file-publisher.lisp.

Use List

common-lisp.

Public Interface
Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Special variables

Special Variable: *directory*

The root directory

Package

restas.file-publisher.

Source

file-publisher.lisp.

Special Variable: *files*

A list of files to be published, can be a path.

Package

restas.file-publisher.

Source

file-publisher.lisp.


5.1.2 Ordinary functions

Function: push-file (file)

Push a relative file/path

Package

restas.file-publisher.

Source

file-publisher.lisp.


5.2 Internals


5.2.1 Ordinary functions

Function: parse-native-namestring (thing)
Package

restas.file-publisher.

Source

file-publisher.lisp.

Function: publish-file-p (file)

Find the file in published list

Package

restas.file-publisher.

Source

file-publisher.lisp.

Function: route (path)
Package

restas.file-publisher.

Source

file-publisher.lisp.


Appendix A Indexes


A.1 Concepts