This is the trivial-mmap Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Jun 15 07:45:20 2025 GMT+0.
The main system appears first, followed by any subsystem dependency.
trivial-mmapA library providing an easy-to-use API for working with memory-mapped files.
Smith Dhumbumroong <zodmaner@gmail.com>
Public Domain
alexandria (system).
osicat (system).
package.lisp (file).
low-level-interface.lisp (file).
trivial-mmap.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
trivial-mmap/trivial-mmap.asdtrivial-mmap/package.lisptrivial-mmap/low-level-interface.lisptrivial-mmap/trivial-mmap.lisptrivial-mmap/low-level-interface.lisppackage.lisp (file).
trivial-mmap (system).
%mmap-file (function).
%mmap-read-byte (function).
%mmap-read-char (function).
%munmap-file (function).
%with-mmap-file (macro).
trivial-mmap/trivial-mmap.lisplow-level-interface.lisp (file).
trivial-mmap (system).
mmap-file (function).
mmap-read-byte (function).
mmap-read-char (function).
mmapped-file-offset (reader).
(setf mmapped-file-offset) (writer).
mmapped-file-p (function).
mmapped-file-pointer (reader).
(setf mmapped-file-pointer) (writer).
mmapped-file-size (reader).
(setf mmapped-file-size) (writer).
munmap-file (function).
with-mmap-file (macro).
copy-mmapped-file (function).
make-mmapped-file (function).
mmapped-file (structure).
Packages are listed by definition order.
trivial-mmapcommon-lisp.
mmap-file (function).
mmap-read-byte (function).
mmap-read-char (function).
mmapped-file-offset (reader).
(setf mmapped-file-offset) (writer).
mmapped-file-p (function).
mmapped-file-pointer (reader).
(setf mmapped-file-pointer) (writer).
mmapped-file-size (reader).
(setf mmapped-file-size) (writer).
munmap-file (function).
with-mmap-file (macro).
%mmap-file (function).
%mmap-read-byte (function).
%mmap-read-char (function).
%munmap-file (function).
%with-mmap-file (macro).
copy-mmapped-file (function).
make-mmapped-file (function).
mmapped-file (structure).
Definitions are sorted by export status, category, package, and then by lexicographic order.
size.
Uses MMAP-FILE to maps a FILENAME into memory.
POINTER-TO-MMAP-FILE and FILE-SIZE are bound to values that MMAP-FILE returns after we apply it to FILENAME.
Maps a FILENAME into memory.
Reads and returns one byte from a memory-mapped file pointed to by the POINTER-TO-MMAP-FILE pointer, offset by OFFSET bytes.
Reads and returns a character from a memory-mapped file pointed to by the POINTER-TO-MMAP-FILE pointer, offset by OFFSET bytes.
Removes a mapping at the address (with the range of FILE-SIZE) that the POINTER-TO-MMAP-FILE pointer points to from memory.
| Jump to: | %
(
C F M W |
|---|
| Jump to: | %
(
C F M W |
|---|
| Jump to: | O P S |
|---|
| Index Entry | Section | ||
|---|---|---|---|
| | |||
| O | |||
offset: | Private structures | ||
| | |||
| P | |||
pointer: | Private structures | ||
| | |||
| S | |||
size: | Private structures | ||
Slot, offset: | Private structures | ||
Slot, pointer: | Private structures | ||
Slot, size: | Private structures | ||
| | |||
| Jump to: | O P S |
|---|
| Jump to: | F L M P S T |
|---|
| Jump to: | F L M P S T |
|---|