This is the deoxybyte-unix Reference Manual, version 0.8.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Jun 15 05:21:25 2025 GMT+0.
deoxybyte-unix/deoxybyte-unix.asddeoxybyte-unix/deoxybyte-unix/package.lispdeoxybyte-unix/deoxybyte-unix/deoxybyte-unix-ffi.lispdeoxybyte-unix/deoxybyte-unix/conditions.lispdeoxybyte-unix/deoxybyte-unix/deoxybyte-unix.lispdeoxybyte-unix/deoxybyte-unix/memory-map.lispdeoxybyte-unix/deoxybyte-unix/sbcl.lispThe main system appears first, followed by any subsystem dependency.
deoxybyte-unixKeith James
GPL v3
0.8.0
deoxybyte-systems (system)., at least version "1.0.0"
cffi (system).
deoxybyte-io (system)., at least version "0.15.0"
deoxybyte-unix (module).
Modules are listed depth-first from the system components tree.
deoxybyte-unix/deoxybyte-unixdeoxybyte-unix (system).
package.lisp (file).
deoxybyte-unix-ffi.lisp (file).
conditions.lisp (file).
deoxybyte-unix.lisp (file).
memory-map.lisp (file).
sbcl.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
deoxybyte-unix/deoxybyte-unix.asddeoxybyte-unix/deoxybyte-unix/package.lispdeoxybyte-unix/deoxybyte-unix/deoxybyte-unix-ffi.lispdeoxybyte-unix/deoxybyte-unix/conditions.lispdeoxybyte-unix/deoxybyte-unix/deoxybyte-unix.lispdeoxybyte-unix/deoxybyte-unix/memory-map.lispdeoxybyte-unix/deoxybyte-unix/sbcl.lispdeoxybyte-unix/deoxybyte-unix.asddeoxybyte-unix (system).
deoxybyte-unix/deoxybyte-unix/package.lispdeoxybyte-unix (module).
deoxybyte-unix/deoxybyte-unix/deoxybyte-unix-ffi.lisppackage.lisp (file).
deoxybyte-unix (module).
%var-accessor-*c-error-number* (function).
(setf %var-accessor-*c-error-number*) (function).
deoxybyte-unix/deoxybyte-unix/conditions.lispdeoxybyte-unix-ffi.lisp (file).
deoxybyte-unix (module).
mapped-file-error (condition).
mapped-index-error (condition).
index-of (reader method).
mapped-file-of (reader method).
deoxybyte-unix/deoxybyte-unix/deoxybyte-unix.lispconditions.lisp (file).
deoxybyte-unix (module).
maybe-standard-stream (function).
deoxybyte-unix/deoxybyte-unix/memory-map.lispdeoxybyte-unix.lisp (file).
deoxybyte-unix (module).
define-mapped-vector (macro).
delete-policy-of (reader method).
filespec-of (reader method).
free-mapped-vector (generic function).
in-memory-p (generic function).
initialize-instance (method).
initialize-instance (method).
initialize-instance (method).
initialize-instance (method).
initialize-instance (method).
initialize-instance (method).
initialize-instance (method).
initialize-instance (method).
initialize-instance (method).
initialize-instance (method).
initialize-instance (method).
initialize-instance (method).
length-of (reader method).
mapped-file (class).
mapped-vector (class).
mapped-vector-char (class).
mapped-vector-double (class).
mapped-vector-float (class).
mapped-vector-int (class).
mapped-vector-int16 (class).
mapped-vector-int32 (class).
mapped-vector-short (class).
mapped-vector-uchar (class).
mapped-vector-uint (class).
mapped-vector-uint16 (class).
mapped-vector-uint32 (class).
mapped-vector-ushort (class).
mmap (function).
mmap-area (structure).
mmap-area-fd (reader).
(setf mmap-area-fd) (writer).
mmap-area-live-p (reader).
(setf mmap-area-live-p) (writer).
mmap-area-ptr (reader).
(setf mmap-area-ptr) (writer).
mmap-area-size (reader).
(setf mmap-area-size) (writer).
mmap-area-type (reader).
(setf mmap-area-type) (writer).
mref (generic function).
(setf mref) (generic function).
munmap (generic function).
print-object (method).
print-object (method).
with-mapped-vector (macro).
%vector-bounds-check (function).
copy-mmap-area (function).
enlarge-file (function).
make-mmap-area (function).
mmap-area-p (function).
unix-tmpfile-template (function).
deoxybyte-unix/deoxybyte-unix/sbcl.lispmemory-map.lisp (file).
deoxybyte-unix (module).
file-descriptor (function).
Packages are listed by definition order.
uk.co.deoxybyte-unixThe deoxybyte-unix package provides a Lisp style
interface to the low level FFI in the :deoxybyte-unix-ffi package.
Some, but not all, Lisp implementations provide a POSIX or Unix package. While deoxybyte-unix treads some well-worn ground in that respect, it should be portable to all Unix platforms supported by CFFI.
deoxybyte-unix
dxn
cffi.
common-lisp.
uk.co.deoxybyte-io.
uk.co.deoxybyte-unix-ffi.
uk.co.deoxybyte-utilities.
define-mapped-vector (macro).
delete-policy-of (generic reader).
file-descriptor (function).
filespec-of (generic reader).
free-mapped-vector (generic function).
in-memory-p (generic function).
length-of (generic reader).
mapped-file (class).
mapped-file-error (condition).
mapped-index-error (condition).
mapped-vector (class).
mapped-vector-char (class).
mapped-vector-double (class).
mapped-vector-float (class).
mapped-vector-int (class).
mapped-vector-int16 (class).
mapped-vector-int32 (class).
mapped-vector-short (class).
mapped-vector-uchar (class).
mapped-vector-uint (class).
mapped-vector-uint16 (class).
mapped-vector-uint32 (class).
mapped-vector-ushort (class).
maybe-standard-stream (function).
mmap (function).
mmap-area (structure).
mmap-area-fd (reader).
(setf mmap-area-fd) (writer).
mmap-area-live-p (reader).
(setf mmap-area-live-p) (writer).
mmap-area-ptr (reader).
(setf mmap-area-ptr) (writer).
mmap-area-size (reader).
(setf mmap-area-size) (writer).
mmap-area-type (reader).
(setf mmap-area-type) (writer).
mref (generic function).
(setf mref) (generic function).
munmap (generic function).
with-mapped-vector (macro).
%vector-bounds-check (function).
copy-mmap-area (function).
enlarge-file (function).
index-of (generic reader).
make-mmap-area (function).
mapped-file-of (generic reader).
mmap-area-p (function).
unix-tmpfile-template (function).
uk.co.deoxybyte-unix-ffiThe deoxybyte-unix-ffi package provides utility
foreign functions to Unix via CFFI. This is a low-level FFI that does
not provide a Lisp-style layer on top of the basic Unix functions. A
small subset of Unix functionality is represented, with further
functions being added as required.
deoxybyte-unix-ffi
unix-ffi
cffi.
common-lisp.
%var-accessor-*c-error-number* (function).
(setf %var-accessor-*c-error-number*) (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Defines a mapped vector class NAME, with accompanying accessor methods ( {defmethod mref} ), specialized to store elements of FOREIGN-TYPE.
Executes BODY in the context of a newly instantiated {defclass mapped-vector} object of CLASS bound to VAR. The vector is safely munmapped after use.
Returns the Unix file descriptor associated with STREAM.
Returns a standard stream (*standard-input* *standard-output* or
*error-output*) if DESIGNATOR is a string that is STRING-EQUAL to one
of "stdin", "stdout" or "stderr", otherwise returns
DESIGNATOR. (Also works for "/dev/stdin" etc.) This function is
useful where one of these strings may be given on a command line to
indicate a system stream, rather than a file-stream is to be used.
Maps a file into memory.
Arguments:
- filespec (pathname designator): The file to be mmapped.
Key:
- length (fixnum): The length of the Lisp vector created when the file
is mmapped.
- foreign-type (symbol): The foreign type of the elements to be stored
in the vector.
- protection (list symbol): The memory protection keyword flags used
in the mmap operation.
Returns:
- A pointer.
fd.
ptr.
size.
type.
mapped-file)) ¶A flag to indicate whether the file
designated in the FILESPEC slot is to be deleted
automatically when the mmapped file is freed. If an
automatically generated tmp is to be used, the value
of this slot is set to T.
mapped-file)) ¶A user-supplied pathname designator for
the file to be mmapped, or NIL an automatically generated
tmp file is to be used.
Frees the mapped memory used by MAPPED-VECTOR.
mapped-vector)) ¶Returns T if MAPPED-FILE is mapped into memory, or NIL otherwise.
mapped-file)) ¶mapped-file)) ¶The length of the Lisp vector created when the file is mmapped.
Returns the value at INDEX in MAPPED-VECTOR.
mapped-vector-uint32) (index fixnum)) ¶mapped-vector-int32) (index fixnum)) ¶mapped-vector-uint16) (index fixnum)) ¶mapped-vector-int16) (index fixnum)) ¶mapped-vector-double) (index fixnum)) ¶mapped-vector-float) (index fixnum)) ¶mapped-vector-uint) (index fixnum)) ¶mapped-vector-int) (index fixnum)) ¶mapped-vector-ushort) (index fixnum)) ¶mapped-vector-short) (index fixnum)) ¶mapped-vector-uchar) (index fixnum)) ¶mapped-vector-char) (index fixnum)) ¶mapped-vector) (index fixnum)) ¶Sets VALUE at INDEX in MAPPED-VECTOR.
mapped-vector-uint32) (index fixnum)) ¶mapped-vector-int32) (index fixnum)) ¶mapped-vector-uint16) (index fixnum)) ¶mapped-vector-int16) (index fixnum)) ¶mapped-vector-double) (index fixnum)) ¶mapped-vector-float) (index fixnum)) ¶mapped-vector-uint) (index fixnum)) ¶mapped-vector-int) (index fixnum)) ¶mapped-vector-ushort) (index fixnum)) ¶mapped-vector-short) (index fixnum)) ¶mapped-vector-uchar) (index fixnum)) ¶mapped-vector-char) (index fixnum)) ¶mapped-vector) (index fixnum)) ¶Frees the mapped memory used by MAPPED-FILE and closes the underlying file descriptor.
mapped-file)) ¶mapped-vector-int16) &key initial-element) ¶mapped-vector-ushort) &key initial-element) ¶mapped-vector-uint16) &key initial-element) ¶mapped-vector-float) &key initial-element) ¶mapped-vector-int32) &key initial-element) ¶mapped-vector-uint) &key initial-element) ¶mapped-vector-uint32) &key initial-element) ¶mapped-vector-int) &key initial-element) ¶mapped-vector-short) &key initial-element) ¶mapped-vector-uchar) &key initial-element) ¶mapped-vector-char) &key initial-element) ¶mapped-vector-double) &key initial-element) ¶mapped-file) stream) ¶mapped-vector) stream) ¶An error that is raised during an operation on a mmapped file.
error.
simple-text-condition.
The mapped file where the error occurred.
:mapped-file
This slot is read-only.
An error that is raised during an index operation on a mmapped file.
An aggregate of data used to describe an mmap operation.
- fr: The mmap file descriptor.
- type: The foreign type in the file being mmapped.
- size: The size in bytes of the region mmapped.
- ptr: The CFFI pointer returned by the mmap foreign function.
- livep: A boolean value which is T if the file is currently mmapped,
or NIL otherwise.
structure-object.
fixnum
0
common-lisp.
symbol
:char
fixnum
0
boolean
A user-supplied pathname designator for
the file to be mmapped, or NIL an automatically generated
tmp file is to be used.
:filespec
This slot is read-only.
A flag to indicate whether the file
designated in the FILESPEC slot is to be deleted
automatically when the mmapped file is freed. If an
automatically generated tmp is to be used, the value
of this slot is set to T.
:delete
This slot is read-only.
The length of the Lisp vector created when the file is mmapped.
common-lisp.
(error "a length argument is required.")
:length
This slot is read-only.
The mmap-area. This slot symbol is
exported to allow direct access without method
dispatch. This is significantly faster, at least on
SBCL.
:mmap-area
A vector backed by a mapped file.
A mapped vector of CHAR.
A mapped vector of DOUBLE.
A mapped vector of FLOAT.
A mapped vector of INT.
A mapped vector of INT16.
A mapped vector of INT32.
A mapped vector of SHORT.
A mapped vector of UNSIGNED-CHAR.
A mapped vector of UNSIGNED-INT.
A mapped vector of UINT16.
A mapped vector of UINT32.
A mapped vector of UNSIGNED-SHORT.
Performs a bounds check on INDEX with respect to LENGTH. Returns T if 0 <= INDEX < LENGTH, or raises an error otherwise.
Enlarges the open file designated by Unix file descriptor FD to FSIZE bytes.
Returns a new temporary file template string suitable for the C mkstemp function. The template is merged with *default-tmpfile-defaults* to supply the directory component.
mapped-index-error)) ¶mapped-file-error)) ¶| Jump to: | %
(
C D E F G I L M P U W |
|---|
| Jump to: | %
(
C D E F G I L M P U W |
|---|
| Jump to: | *
D F I L M P S T |
|---|
| Jump to: | *
D F I L M P S T |
|---|
| Jump to: | C D F M P S U |
|---|
| Jump to: | C D F M P S U |
|---|