The deoxybyte-unix Reference Manual

This is the deoxybyte-unix Reference Manual, version 0.8.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 05:05:30 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 deoxybyte-unix

Author

Keith James

License

GPL v3

Version

0.8.0

Dependencies
  • deoxybyte-systems (system)., at least version "1.0.0"
  • cffi (system).
  • deoxybyte-io (system)., at least version "0.15.0"
Source

deoxybyte-unix.asd.

Child Component

deoxybyte-unix (module).


3 Modules

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


3.1 deoxybyte-unix/deoxybyte-unix

Source

deoxybyte-unix.asd.

Parent Component

deoxybyte-unix (system).

Child Components

4 Files

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


4.1 Lisp


4.1.1 deoxybyte-unix/deoxybyte-unix.asd

Source

deoxybyte-unix.asd.

Parent Component

deoxybyte-unix (system).

ASDF Systems

deoxybyte-unix.


4.1.2 deoxybyte-unix/deoxybyte-unix/package.lisp

Source

deoxybyte-unix.asd.

Parent Component

deoxybyte-unix (module).

Packages

4.1.3 deoxybyte-unix/deoxybyte-unix/deoxybyte-unix-ffi.lisp

Dependency

package.lisp (file).

Source

deoxybyte-unix.asd.

Parent Component

deoxybyte-unix (module).

Public Interface
Internals

4.1.4 deoxybyte-unix/deoxybyte-unix/conditions.lisp

Dependency

deoxybyte-unix-ffi.lisp (file).

Source

deoxybyte-unix.asd.

Parent Component

deoxybyte-unix (module).

Public Interface
Internals

4.1.5 deoxybyte-unix/deoxybyte-unix/deoxybyte-unix.lisp

Dependency

conditions.lisp (file).

Source

deoxybyte-unix.asd.

Parent Component

deoxybyte-unix (module).

Public Interface

maybe-standard-stream (function).


4.1.6 deoxybyte-unix/deoxybyte-unix/memory-map.lisp

Dependency

deoxybyte-unix.lisp (file).

Source

deoxybyte-unix.asd.

Parent Component

deoxybyte-unix (module).

Public Interface
Internals

4.1.7 deoxybyte-unix/deoxybyte-unix/sbcl.lisp

Dependency

memory-map.lisp (file).

Source

deoxybyte-unix.asd.

Parent Component

deoxybyte-unix (module).

Public Interface

file-descriptor (function).


5 Packages

Packages are listed by definition order.


5.1 uk.co.deoxybyte-unix

The 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.

Source

package.lisp.

Nicknames
  • deoxybyte-unix
  • dxn
Use List
Public Interface
Internals

5.2 uk.co.deoxybyte-unix-ffi

The 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.

Source

package.lisp.

Nicknames
  • deoxybyte-unix-ffi
  • unix-ffi
Use List
  • cffi.
  • common-lisp.
Used By List

uk.co.deoxybyte-unix.

Public Interface
Internals

6 Definitions

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


6.1 Public Interface


6.1.1 Symbol macros

Symbol Macro: *c-error-number*
Package

uk.co.deoxybyte-unix-ffi.

Source

deoxybyte-unix-ffi.lisp.


6.1.2 Macros

Macro: define-mapped-vector (name foreign-type &optional docstring)

Defines a mapped vector class NAME, with accompanying accessor methods ( {defmethod mref} ), specialized to store elements of FOREIGN-TYPE.

Package

uk.co.deoxybyte-unix.

Source

memory-map.lisp.

Macro: with-mapped-vector ((var class &rest initargs) &body body)

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.

Package

uk.co.deoxybyte-unix.

Source

memory-map.lisp.


6.1.3 Ordinary functions

Function: c-close (file-descriptor)
Package

uk.co.deoxybyte-unix-ffi.

Source

deoxybyte-unix-ffi.lisp.

Function: c-fileno (stream)
Package

uk.co.deoxybyte-unix-ffi.

Source

deoxybyte-unix-ffi.lisp.

Function: c-lseek (file-descriptor offset whence)
Package

uk.co.deoxybyte-unix-ffi.

Source

deoxybyte-unix-ffi.lisp.

Function: c-mkstemp (template)
Package

uk.co.deoxybyte-unix-ffi.

Source

deoxybyte-unix-ffi.lisp.

Function: c-mmap (address length protection flags file-descriptor offset)
Package

uk.co.deoxybyte-unix-ffi.

Source

deoxybyte-unix-ffi.lisp.

Function: c-munmap (address length)
Package

uk.co.deoxybyte-unix-ffi.

Source

deoxybyte-unix-ffi.lisp.

Function: c-open (path flags mode)
Package

uk.co.deoxybyte-unix-ffi.

Source

deoxybyte-unix-ffi.lisp.

Function: c-strerror (errno)
Package

uk.co.deoxybyte-unix-ffi.

Source

deoxybyte-unix-ffi.lisp.

Function: c-sysconf (name)
Package

uk.co.deoxybyte-unix-ffi.

Source

deoxybyte-unix-ffi.lisp.

Function: c-write (file-descriptor value count)
Package

uk.co.deoxybyte-unix-ffi.

Source

deoxybyte-unix-ffi.lisp.

Function: file-descriptor (stream &optional direction)

Returns the Unix file descriptor associated with STREAM.

Package

uk.co.deoxybyte-unix.

Source

sbcl.lisp.

Function: maybe-standard-stream (designator)

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.

Package

uk.co.deoxybyte-unix.

Source

deoxybyte-unix.lisp.

Function: mmap (filespec &key length foreign-type protection)

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.

Package

uk.co.deoxybyte-unix.

Source

memory-map.lisp.

Reader: mmap-area-fd (instance)
Writer: (setf mmap-area-fd) (instance)
Package

uk.co.deoxybyte-unix.

Source

memory-map.lisp.

Target Slot

fd.

Reader: mmap-area-live-p (instance)
Writer: (setf mmap-area-live-p) (instance)
Package

uk.co.deoxybyte-unix.

Source

memory-map.lisp.

Target Slot

live-p.

Reader: mmap-area-ptr (instance)
Writer: (setf mmap-area-ptr) (instance)
Package

uk.co.deoxybyte-unix.

Source

memory-map.lisp.

Target Slot

ptr.

Reader: mmap-area-size (instance)
Writer: (setf mmap-area-size) (instance)
Package

uk.co.deoxybyte-unix.

Source

memory-map.lisp.

Target Slot

size.

Reader: mmap-area-type (instance)
Writer: (setf mmap-area-type) (instance)
Package

uk.co.deoxybyte-unix.

Source

memory-map.lisp.

Target Slot

type.


6.1.4 Generic functions

Generic Reader: delete-policy-of (object)
Package

uk.co.deoxybyte-unix.

Methods
Reader Method: delete-policy-of ((mapped-file 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.

Source

memory-map.lisp.

Target Slot

delete-policy.

Generic Reader: filespec-of (object)
Package

uk.co.deoxybyte-unix.

Methods
Reader Method: filespec-of ((mapped-file mapped-file))

A user-supplied pathname designator for
the file to be mmapped, or NIL an automatically generated tmp file is to be used.

Source

memory-map.lisp.

Target Slot

filespec.

Generic Function: free-mapped-vector (mapped-vector)

Frees the mapped memory used by MAPPED-VECTOR.

Package

uk.co.deoxybyte-unix.

Source

memory-map.lisp.

Methods
Method: free-mapped-vector ((vector mapped-vector))
Generic Function: in-memory-p (mapped-file)

Returns T if MAPPED-FILE is mapped into memory, or NIL otherwise.

Package

uk.co.deoxybyte-unix.

Source

memory-map.lisp.

Methods
Method: in-memory-p ((obj mapped-file))
Generic Reader: length-of (object)
Package

uk.co.deoxybyte-unix.

Methods
Reader Method: length-of ((mapped-file mapped-file))

The length of the Lisp vector created when the file is mmapped.

Source

memory-map.lisp.

Target Slot

length.

Generic Function: mref (mapped-vector index)

Returns the value at INDEX in MAPPED-VECTOR.

Package

uk.co.deoxybyte-unix.

Source

memory-map.lisp.

Methods
Method: mref ((vector mapped-vector-uint32) (index fixnum))
Method: mref ((vector mapped-vector-int32) (index fixnum))
Method: mref ((vector mapped-vector-uint16) (index fixnum))
Method: mref ((vector mapped-vector-int16) (index fixnum))
Method: mref ((vector mapped-vector-double) (index fixnum))
Method: mref ((vector mapped-vector-float) (index fixnum))
Method: mref ((vector mapped-vector-uint) (index fixnum))
Method: mref ((vector mapped-vector-int) (index fixnum))
Method: mref ((vector mapped-vector-ushort) (index fixnum))
Method: mref ((vector mapped-vector-short) (index fixnum))
Method: mref ((vector mapped-vector-uchar) (index fixnum))
Method: mref ((vector mapped-vector-char) (index fixnum))
Method: mref :before ((vector mapped-vector) (index fixnum))
Generic Function: (setf mref) (mapped-vector index)

Sets VALUE at INDEX in MAPPED-VECTOR.

Package

uk.co.deoxybyte-unix.

Source

memory-map.lisp.

Methods
Method: (setf mref) ((vector mapped-vector-uint32) (index fixnum))
Method: (setf mref) ((vector mapped-vector-int32) (index fixnum))
Method: (setf mref) ((vector mapped-vector-uint16) (index fixnum))
Method: (setf mref) ((vector mapped-vector-int16) (index fixnum))
Method: (setf mref) ((vector mapped-vector-double) (index fixnum))
Method: (setf mref) ((vector mapped-vector-float) (index fixnum))
Method: (setf mref) ((vector mapped-vector-uint) (index fixnum))
Method: (setf mref) ((vector mapped-vector-int) (index fixnum))
Method: (setf mref) ((vector mapped-vector-ushort) (index fixnum))
Method: (setf mref) ((vector mapped-vector-short) (index fixnum))
Method: (setf mref) ((vector mapped-vector-uchar) (index fixnum))
Method: (setf mref) ((vector mapped-vector-char) (index fixnum))
Method: (setf mref) :before ((vector mapped-vector) (index fixnum))
Generic Function: munmap (mapped-file)

Frees the mapped memory used by MAPPED-FILE and closes the underlying file descriptor.

Package

uk.co.deoxybyte-unix.

Source

memory-map.lisp.

Methods
Method: munmap ((obj mapped-file))

6.1.5 Standalone methods

Method: initialize-instance :after ((vector mapped-vector-int16) &key initial-element)
Source

memory-map.lisp.

Method: initialize-instance :after ((vector mapped-vector-ushort) &key initial-element)
Source

memory-map.lisp.

Method: initialize-instance :after ((vector mapped-vector-uint16) &key initial-element)
Source

memory-map.lisp.

Method: initialize-instance :after ((vector mapped-vector-float) &key initial-element)
Source

memory-map.lisp.

Method: initialize-instance :after ((vector mapped-vector-int32) &key initial-element)
Source

memory-map.lisp.

Method: initialize-instance :after ((vector mapped-vector-uint) &key initial-element)
Source

memory-map.lisp.

Method: initialize-instance :after ((vector mapped-vector-uint32) &key initial-element)
Source

memory-map.lisp.

Method: initialize-instance :after ((vector mapped-vector-int) &key initial-element)
Source

memory-map.lisp.

Method: initialize-instance :after ((vector mapped-vector-short) &key initial-element)
Source

memory-map.lisp.

Method: initialize-instance :after ((vector mapped-vector-uchar) &key initial-element)
Source

memory-map.lisp.

Method: initialize-instance :after ((vector mapped-vector-char) &key initial-element)
Source

memory-map.lisp.

Method: initialize-instance :after ((vector mapped-vector-double) &key initial-element)
Source

memory-map.lisp.

Method: print-object ((mapped-file mapped-file) stream)
Source

memory-map.lisp.

Method: print-object ((mapped-vector mapped-vector) stream)
Source

memory-map.lisp.


6.1.6 Conditions

Condition: mapped-file-error

An error that is raised during an operation on a mmapped file.

Package

uk.co.deoxybyte-unix.

Source

conditions.lisp.

Direct superclasses
  • error.
  • simple-text-condition.
Direct subclasses

mapped-index-error.

Direct methods

mapped-file-of.

Direct slots
Slot: mapped-file

The mapped file where the error occurred.

Initargs

:mapped-file

Readers

mapped-file-of.

Writers

This slot is read-only.

Condition: mapped-index-error

An error that is raised during an index operation on a mmapped file.

Package

uk.co.deoxybyte-unix.

Source

conditions.lisp.

Direct superclasses

mapped-file-error.

Direct methods

index-of.

Direct slots
Slot: index

The index that caused the error.

Initform

(quote nil)

Initargs

:index

Readers

index-of.

Writers

This slot is read-only.


6.1.7 Structures

Structure: mmap-area

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.

Package

uk.co.deoxybyte-unix.

Source

memory-map.lisp.

Direct superclasses

structure-object.

Direct slots
Slot: fd
Type

fixnum

Initform

0

Readers

mmap-area-fd.

Writers

(setf mmap-area-fd).

Slot: type
Package

common-lisp.

Type

symbol

Initform

:char

Readers

mmap-area-type.

Writers

(setf mmap-area-type).

Slot: size
Type

fixnum

Initform

0

Readers

mmap-area-size.

Writers

(setf mmap-area-size).

Slot: ptr
Readers

mmap-area-ptr.

Writers

(setf mmap-area-ptr).

Slot: live-p
Type

boolean

Readers

mmap-area-live-p.

Writers

(setf mmap-area-live-p).


6.1.8 Classes

Class: mapped-file
Package

uk.co.deoxybyte-unix.

Source

memory-map.lisp.

Direct subclasses

mapped-vector.

Direct methods
Direct slots
Slot: filespec

A user-supplied pathname designator for
the file to be mmapped, or NIL an automatically generated tmp file is to be used.

Initargs

:filespec

Readers

filespec-of.

Writers

This slot is read-only.

Slot: delete-policy

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.

Initargs

:delete

Readers

delete-policy-of.

Writers

This slot is read-only.

Slot: length

The length of the Lisp vector created when the file is mmapped.

Package

common-lisp.

Initform

(error "a length argument is required.")

Initargs

:length

Readers

length-of.

Writers

This slot is read-only.

Slot: mmap-area

The mmap-area. This slot symbol is
exported to allow direct access without method dispatch. This is significantly faster, at least on SBCL.

Initargs

:mmap-area

Class: mapped-vector

A vector backed by a mapped file.

Package

uk.co.deoxybyte-unix.

Source

memory-map.lisp.

Direct superclasses

mapped-file.

Direct subclasses
Direct methods
Class: mapped-vector-char

A mapped vector of CHAR.

Package

uk.co.deoxybyte-unix.

Source

memory-map.lisp.

Direct superclasses

mapped-vector.

Direct methods
Class: mapped-vector-double

A mapped vector of DOUBLE.

Package

uk.co.deoxybyte-unix.

Source

memory-map.lisp.

Direct superclasses

mapped-vector.

Direct methods
Class: mapped-vector-float

A mapped vector of FLOAT.

Package

uk.co.deoxybyte-unix.

Source

memory-map.lisp.

Direct superclasses

mapped-vector.

Direct methods
Class: mapped-vector-int

A mapped vector of INT.

Package

uk.co.deoxybyte-unix.

Source

memory-map.lisp.

Direct superclasses

mapped-vector.

Direct methods
Class: mapped-vector-int16

A mapped vector of INT16.

Package

uk.co.deoxybyte-unix.

Source

memory-map.lisp.

Direct superclasses

mapped-vector.

Direct methods
Class: mapped-vector-int32

A mapped vector of INT32.

Package

uk.co.deoxybyte-unix.

Source

memory-map.lisp.

Direct superclasses

mapped-vector.

Direct methods
Class: mapped-vector-short

A mapped vector of SHORT.

Package

uk.co.deoxybyte-unix.

Source

memory-map.lisp.

Direct superclasses

mapped-vector.

Direct methods
Class: mapped-vector-uchar

A mapped vector of UNSIGNED-CHAR.

Package

uk.co.deoxybyte-unix.

Source

memory-map.lisp.

Direct superclasses

mapped-vector.

Direct methods
Class: mapped-vector-uint

A mapped vector of UNSIGNED-INT.

Package

uk.co.deoxybyte-unix.

Source

memory-map.lisp.

Direct superclasses

mapped-vector.

Direct methods
Class: mapped-vector-uint16

A mapped vector of UINT16.

Package

uk.co.deoxybyte-unix.

Source

memory-map.lisp.

Direct superclasses

mapped-vector.

Direct methods
Class: mapped-vector-uint32

A mapped vector of UINT32.

Package

uk.co.deoxybyte-unix.

Source

memory-map.lisp.

Direct superclasses

mapped-vector.

Direct methods
Class: mapped-vector-ushort

A mapped vector of UNSIGNED-SHORT.

Package

uk.co.deoxybyte-unix.

Source

memory-map.lisp.

Direct superclasses

mapped-vector.

Direct methods

6.2 Internals


6.2.1 Ordinary functions

Function: %var-accessor-*c-error-number* ()
Package

uk.co.deoxybyte-unix-ffi.

Source

deoxybyte-unix-ffi.lisp.

Function: (setf %var-accessor-*c-error-number*) ()
Package

uk.co.deoxybyte-unix-ffi.

Source

deoxybyte-unix-ffi.lisp.

Function: %vector-bounds-check (vector index)

Performs a bounds check on INDEX with respect to LENGTH. Returns T if 0 <= INDEX < LENGTH, or raises an error otherwise.

Package

uk.co.deoxybyte-unix.

Source

memory-map.lisp.

Function: copy-mmap-area (instance)
Package

uk.co.deoxybyte-unix.

Source

memory-map.lisp.

Function: enlarge-file (fd fsize)

Enlarges the open file designated by Unix file descriptor FD to FSIZE bytes.

Package

uk.co.deoxybyte-unix.

Source

memory-map.lisp.

Function: make-mmap-area (&key fd type size ptr live-p)
Package

uk.co.deoxybyte-unix.

Source

memory-map.lisp.

Function: mmap-area-p (object)
Package

uk.co.deoxybyte-unix.

Source

memory-map.lisp.

Function: unix-tmpfile-template ()

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.

Package

uk.co.deoxybyte-unix.

Source

memory-map.lisp.


6.2.2 Generic functions

Generic Reader: index-of (condition)
Package

uk.co.deoxybyte-unix.

Methods
Reader Method: index-of ((condition mapped-index-error))
Source

conditions.lisp.

Target Slot

index.

Generic Reader: mapped-file-of (condition)
Package

uk.co.deoxybyte-unix.

Methods
Reader Method: mapped-file-of ((condition mapped-file-error))
Source

conditions.lisp.

Target Slot

mapped-file.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   %   (  
C   D   E   F   G   I   L   M   P   U   W  
Index Entry  Section

%
%var-accessor-*c-error-number*: Private ordinary functions
%vector-bounds-check: Private ordinary functions

(
(setf %var-accessor-*c-error-number*): Private ordinary functions
(setf mmap-area-fd): Public ordinary functions
(setf mmap-area-live-p): Public ordinary functions
(setf mmap-area-ptr): Public ordinary functions
(setf mmap-area-size): Public ordinary functions
(setf mmap-area-type): Public ordinary functions
(setf mref): Public generic functions
(setf mref): Public generic functions
(setf mref): Public generic functions
(setf mref): Public generic functions
(setf mref): Public generic functions
(setf mref): Public generic functions
(setf mref): Public generic functions
(setf mref): Public generic functions
(setf mref): Public generic functions
(setf mref): Public generic functions
(setf mref): Public generic functions
(setf mref): Public generic functions
(setf mref): Public generic functions
(setf mref): Public generic functions

C
c-close: Public ordinary functions
c-fileno: Public ordinary functions
c-lseek: Public ordinary functions
c-mkstemp: Public ordinary functions
c-mmap: Public ordinary functions
c-munmap: Public ordinary functions
c-open: Public ordinary functions
c-strerror: Public ordinary functions
c-sysconf: Public ordinary functions
c-write: Public ordinary functions
copy-mmap-area: Private ordinary functions

D
define-mapped-vector: Public macros
delete-policy-of: Public generic functions
delete-policy-of: Public generic functions

E
enlarge-file: Private ordinary functions

F
file-descriptor: Public ordinary functions
filespec-of: Public generic functions
filespec-of: Public generic functions
free-mapped-vector: Public generic functions
free-mapped-vector: Public generic functions
Function, %var-accessor-*c-error-number*: Private ordinary functions
Function, %vector-bounds-check: Private ordinary functions
Function, (setf %var-accessor-*c-error-number*): Private ordinary functions
Function, (setf mmap-area-fd): Public ordinary functions
Function, (setf mmap-area-live-p): Public ordinary functions
Function, (setf mmap-area-ptr): Public ordinary functions
Function, (setf mmap-area-size): Public ordinary functions
Function, (setf mmap-area-type): Public ordinary functions
Function, c-close: Public ordinary functions
Function, c-fileno: Public ordinary functions
Function, c-lseek: Public ordinary functions
Function, c-mkstemp: Public ordinary functions
Function, c-mmap: Public ordinary functions
Function, c-munmap: Public ordinary functions
Function, c-open: Public ordinary functions
Function, c-strerror: Public ordinary functions
Function, c-sysconf: Public ordinary functions
Function, c-write: Public ordinary functions
Function, copy-mmap-area: Private ordinary functions
Function, enlarge-file: Private ordinary functions
Function, file-descriptor: Public ordinary functions
Function, make-mmap-area: Private ordinary functions
Function, maybe-standard-stream: Public ordinary functions
Function, mmap: Public ordinary functions
Function, mmap-area-fd: Public ordinary functions
Function, mmap-area-live-p: Public ordinary functions
Function, mmap-area-p: Private ordinary functions
Function, mmap-area-ptr: Public ordinary functions
Function, mmap-area-size: Public ordinary functions
Function, mmap-area-type: Public ordinary functions
Function, unix-tmpfile-template: Private ordinary functions

G
Generic Function, (setf mref): Public generic functions
Generic Function, delete-policy-of: Public generic functions
Generic Function, filespec-of: Public generic functions
Generic Function, free-mapped-vector: Public generic functions
Generic Function, in-memory-p: Public generic functions
Generic Function, index-of: Private generic functions
Generic Function, length-of: Public generic functions
Generic Function, mapped-file-of: Private generic functions
Generic Function, mref: Public generic functions
Generic Function, munmap: Public generic functions

I
in-memory-p: Public generic functions
in-memory-p: Public generic functions
index-of: Private generic functions
index-of: Private generic functions
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods

L
length-of: Public generic functions
length-of: Public generic functions

M
Macro, define-mapped-vector: Public macros
Macro, with-mapped-vector: Public macros
make-mmap-area: Private ordinary functions
mapped-file-of: Private generic functions
mapped-file-of: Private generic functions
maybe-standard-stream: Public ordinary functions
Method, (setf mref): Public generic functions
Method, (setf mref): Public generic functions
Method, (setf mref): Public generic functions
Method, (setf mref): Public generic functions
Method, (setf mref): Public generic functions
Method, (setf mref): Public generic functions
Method, (setf mref): Public generic functions
Method, (setf mref): Public generic functions
Method, (setf mref): Public generic functions
Method, (setf mref): Public generic functions
Method, (setf mref): Public generic functions
Method, (setf mref): Public generic functions
Method, (setf mref): Public generic functions
Method, delete-policy-of: Public generic functions
Method, filespec-of: Public generic functions
Method, free-mapped-vector: Public generic functions
Method, in-memory-p: Public generic functions
Method, index-of: Private generic functions
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, length-of: Public generic functions
Method, mapped-file-of: Private generic functions
Method, mref: Public generic functions
Method, mref: Public generic functions
Method, mref: Public generic functions
Method, mref: Public generic functions
Method, mref: Public generic functions
Method, mref: Public generic functions
Method, mref: Public generic functions
Method, mref: Public generic functions
Method, mref: Public generic functions
Method, mref: Public generic functions
Method, mref: Public generic functions
Method, mref: Public generic functions
Method, mref: Public generic functions
Method, munmap: Public generic functions
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
mmap: Public ordinary functions
mmap-area-fd: Public ordinary functions
mmap-area-live-p: Public ordinary functions
mmap-area-p: Private ordinary functions
mmap-area-ptr: Public ordinary functions
mmap-area-size: Public ordinary functions
mmap-area-type: Public ordinary functions
mref: Public generic functions
mref: Public generic functions
mref: Public generic functions
mref: Public generic functions
mref: Public generic functions
mref: Public generic functions
mref: Public generic functions
mref: Public generic functions
mref: Public generic functions
mref: Public generic functions
mref: Public generic functions
mref: Public generic functions
mref: Public generic functions
mref: Public generic functions
munmap: Public generic functions
munmap: Public generic functions

P
print-object: Public standalone methods
print-object: Public standalone methods

U
unix-tmpfile-template: Private ordinary functions

W
with-mapped-vector: Public macros


A.4 Data types

Jump to:   C   D   F   M   P   S   U  
Index Entry  Section

C
Class, mapped-file: Public classes
Class, mapped-vector: Public classes
Class, mapped-vector-char: Public classes
Class, mapped-vector-double: Public classes
Class, mapped-vector-float: Public classes
Class, mapped-vector-int: Public classes
Class, mapped-vector-int16: Public classes
Class, mapped-vector-int32: Public classes
Class, mapped-vector-short: Public classes
Class, mapped-vector-uchar: Public classes
Class, mapped-vector-uint: Public classes
Class, mapped-vector-uint16: Public classes
Class, mapped-vector-uint32: Public classes
Class, mapped-vector-ushort: Public classes
Condition, mapped-file-error: Public conditions
Condition, mapped-index-error: Public conditions
conditions.lisp: The deoxybyte-unix/deoxybyte-unix/conditions․lisp file

D
deoxybyte-unix: The deoxybyte-unix system
deoxybyte-unix: The deoxybyte-unix/deoxybyte-unix module
deoxybyte-unix-ffi.lisp: The deoxybyte-unix/deoxybyte-unix/deoxybyte-unix-ffi․lisp file
deoxybyte-unix.asd: The deoxybyte-unix/deoxybyte-unix․asd file
deoxybyte-unix.lisp: The deoxybyte-unix/deoxybyte-unix/deoxybyte-unix․lisp file

F
File, conditions.lisp: The deoxybyte-unix/deoxybyte-unix/conditions․lisp file
File, deoxybyte-unix-ffi.lisp: The deoxybyte-unix/deoxybyte-unix/deoxybyte-unix-ffi․lisp file
File, deoxybyte-unix.asd: The deoxybyte-unix/deoxybyte-unix․asd file
File, deoxybyte-unix.lisp: The deoxybyte-unix/deoxybyte-unix/deoxybyte-unix․lisp file
File, memory-map.lisp: The deoxybyte-unix/deoxybyte-unix/memory-map․lisp file
File, package.lisp: The deoxybyte-unix/deoxybyte-unix/package․lisp file
File, sbcl.lisp: The deoxybyte-unix/deoxybyte-unix/sbcl․lisp file

M
mapped-file: Public classes
mapped-file-error: Public conditions
mapped-index-error: Public conditions
mapped-vector: Public classes
mapped-vector-char: Public classes
mapped-vector-double: Public classes
mapped-vector-float: Public classes
mapped-vector-int: Public classes
mapped-vector-int16: Public classes
mapped-vector-int32: Public classes
mapped-vector-short: Public classes
mapped-vector-uchar: Public classes
mapped-vector-uint: Public classes
mapped-vector-uint16: Public classes
mapped-vector-uint32: Public classes
mapped-vector-ushort: Public classes
memory-map.lisp: The deoxybyte-unix/deoxybyte-unix/memory-map․lisp file
mmap-area: Public structures
Module, deoxybyte-unix: The deoxybyte-unix/deoxybyte-unix module

P
Package, uk.co.deoxybyte-unix: The uk․co․deoxybyte-unix package
Package, uk.co.deoxybyte-unix-ffi: The uk․co․deoxybyte-unix-ffi package
package.lisp: The deoxybyte-unix/deoxybyte-unix/package․lisp file

S
sbcl.lisp: The deoxybyte-unix/deoxybyte-unix/sbcl․lisp file
Structure, mmap-area: Public structures
System, deoxybyte-unix: The deoxybyte-unix system

U
uk.co.deoxybyte-unix: The uk․co․deoxybyte-unix package
uk.co.deoxybyte-unix-ffi: The uk․co․deoxybyte-unix-ffi package