The restas.file-publisher Reference Manual

Table of Contents

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

The restas.file-publisher Reference Manual

This is the restas.file-publisher Reference Manual, version 0.1, generated automatically by Declt version 2.3 "Robert April" on Tue Jan 09 15:39:23 2018 GMT+0.


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

1 Introduction

restas.file-publisher is a restas module which can publish static files to http
client. See restas module() for
details.

It's licensed by MIT.

Usage

(restas:mount-submodule
  publisher (#:restas.file-publisher route)
  (restas.file-publisher:*directory* '("image/" "data/"))
  (restas.file-publisher:*files* '("image/jpg/" "image/other/*/" "data/*/*/")))

This will create a resta route to serve all these directories files.

Author: Kevin Lynx 



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

2 Systems

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


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

2.1 restas.file-publisher

Author

Kevin Lynx <kevinlynx@gmail.com>

License

MIT

Description

A restas module which can publish static files

Version

0.1

Dependencies
Source

restas.file-publisher.asd (file)

Component

file-publisher.lisp (file)


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

3 Files

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


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

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 restas.file-publisher.asd

Location

restas.file-publisher.asd

Systems

restas.file-publisher (system)


Previous: , Up: Lisp files   [Contents][Index]

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

Parent

restas.file-publisher (system)

Location

file-publisher.lisp

Packages

restas.file-publisher

Exported Definitions
Internal Definitions

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

4 Packages

Packages are listed by definition order.


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

4.1 restas.file-publisher

Source

file-publisher.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

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

5 Definitions

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


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

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Special variables

Special Variable: *directory*

The root directory

Package

restas.file-publisher

Source

file-publisher.lisp (file)

Special Variable: *files*

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

Package

restas.file-publisher

Source

file-publisher.lisp (file)


Previous: , Up: Exported definitions   [Contents][Index]

5.1.2 Functions

Function: push-file FILE

Push a relative file/path

Package

restas.file-publisher

Source

file-publisher.lisp (file)


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

5.2 Internal definitions


Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Functions

Function: parse-native-namestring THING
Package

restas.file-publisher

Source

file-publisher.lisp (file)

Function: publish-file-p FILE

Find the file in published list

Package

restas.file-publisher

Source

file-publisher.lisp (file)

Function: route PATH
Package

restas.file-publisher

Source

file-publisher.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   R  
Index Entry  Section

F
File, Lisp, restas.file-publisher.asd: The restas<dot>file-publisher<dot>asd file
File, Lisp, restas.file-publisher/file-publisher.lisp: The restas<dot>file-publisher/file-publisher<dot>lisp file

L
Lisp File, restas.file-publisher.asd: The restas<dot>file-publisher<dot>asd file
Lisp File, restas.file-publisher/file-publisher.lisp: The restas<dot>file-publisher/file-publisher<dot>lisp file

R
restas.file-publisher.asd: The restas<dot>file-publisher<dot>asd file
restas.file-publisher/file-publisher.lisp: The restas<dot>file-publisher/file-publisher<dot>lisp file

Jump to:   F   L   R  

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

A.2 Functions

Jump to:   F   P   R  
Index Entry  Section

F
Function, parse-native-namestring: Internal functions
Function, publish-file-p: Internal functions
Function, push-file: Exported functions
Function, route: Internal functions

P
parse-native-namestring: Internal functions
publish-file-p: Internal functions
push-file: Exported functions

R
route: Internal functions

Jump to:   F   P   R  

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

A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*directory*: Exported special variables
*files*: Exported special variables

S
Special Variable, *directory*: Exported special variables
Special Variable, *files*: Exported special variables

Jump to:   *  
S  

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

A.4 Data types

Jump to:   P   R   S  
Index Entry  Section

P
Package, restas.file-publisher: The restas<dot>file-publisher package

R
restas.file-publisher: The restas<dot>file-publisher system
restas.file-publisher: The restas<dot>file-publisher package

S
System, restas.file-publisher: The restas<dot>file-publisher system

Jump to:   P   R   S