The nfiles Reference Manual

Table of Contents

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

The nfiles Reference Manual

This is the nfiles Reference Manual, version 0.2.2, generated automatically by Declt version 3.0 "Montgomery Scott" on Sun May 15 05:40:02 2022 GMT+0.


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

1 Systems

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


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

1.1 nfiles

Author

Atlas Engineer LLC

Home Page

https://github.com/atlas-engineer/nfiles

License

BSD 3-Clause

Description

Manage file persistence and loading.

Version

0.2.2

Dependencies
Source

nfiles.asd (file)

Components

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

2 Files

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


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

2.1 Lisp


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

2.1.1 nfiles.asd

Location

nfiles.asd

Systems

nfiles (system)


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

2.1.2 nfiles/package.lisp

Parent

nfiles (system)

Location

package.lisp

Packages

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

2.1.3 nfiles/conditions.lisp

Parent

nfiles (system)

Location

conditions.lisp

Exported Definitions

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

2.1.4 nfiles/pathname-helpers.lisp

Parent

nfiles (system)

Location

pathname-helpers.lisp

Exported Definitions
Internal Definitions

+permissions+ (constant)


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

2.1.5 nfiles/gpg.lisp

Parent

nfiles (system)

Location

gpg.lisp

Exported Definitions
Internal Definitions

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

2.1.6 nfiles/nfiles.lisp

Parent

nfiles (system)

Location

nfiles.lisp

Exported Definitions
Internal Definitions

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

3 Packages

Packages are listed by definition order.


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

3.1 nfiles

The main data structures are ‘file’ and ‘profile’.
Call ‘expand’ to return the final ‘file’ path.
Call ‘content’ (setf-able) to get the ‘file’ content.

Specialize ‘resolve’ to configure how a file path is expanded depending on the file type and the ‘profile’.

The content serialization and deserialization can be specialized via the ‘serialize’ and ‘deserialize’ methods.

The file reading and writing can be specialized via the ‘file-read’ and ‘file-write’ methods.

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

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

3.2 nfiles/gpg

A thin wrapper around the GPG command line tool.

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

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

4 Definitions

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


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

4.1 Exported definitions


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

4.1.1 Special variables

Special Variable: *default-profile*
Package

nfiles

Source

nfiles.lisp (file)

Special Variable: *gpg-default-recipient*
Package

nfiles/gpg

Source

gpg.lisp (file)

Special Variable: *gpg-program*
Package

nfiles/gpg

Source

gpg.lisp (file)


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

4.1.2 Macros

Macro: with-file-content (CONTENT FILE &key DEFAULT) &body BODY

Bind CONTENT to FILE’s content in BODY.
In case there’s no content, bind CONTENT to DEFAULT. The new value of CONTENT is saved to FILE on exit.

Package

nfiles

Source

nfiles.lisp (file)

Macro: with-gpg-file (VAR PATHNAME &rest KEYS) &body BODY

Trivial wrapper around ‘call-with-gpg-file’.

Package

nfiles/gpg

Source

gpg.lisp (file)

Macro: with-paths BINDINGS &body BODY

Bind let-style BINDINGS to ‘file’ path expansions, then run BODY if all these paths or non-nil after ‘nil-pathname-p’.

Package

nfiles

Source

nfiles.lisp (file)


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

4.1.3 Functions

Function: all-files &rest PACKAGES

Return all instantiated ‘file’ objects belong to PACKAGES. If no package is specified, return all ‘file’ objects.

Package

nfiles

Source

nfiles.lisp (file)

Function: backup PATH

Rename PATH to a file of the same name with a unique suffix appended. The file is guaranteed to not conflict with any existing file.

Package

nfiles

Source

nfiles.lisp (file)

Function: content FILE &key FORCE-READ WAIT-P

Return the content of FILE.
When FORCE-READ is non-nil, the cache is skipped and the file is re-read.

The read is asynchronous. By default, ‘content’ waits for the read to finish before returning the result. But if ‘wait-p’ is nil, it returns directly with (VALUES NIL THREAD) if the reading THREAD is not done yet.

Package

nfiles

Source

nfiles.lisp (file)

Writer

(setf content) (function)

Function: (setf content) VALUE FILE

Set FILE content to VALUE and persist change to disk.
While the content of the FILE object is updated instantly, the file is persisted in the background.

Return a ‘bt:thread’ object. Call ‘bt:join-thread’ on it to know when it’s done writing the file.

Package

nfiles

Source

nfiles.lisp (file)

Reader

content (function)

Function: expand FILE

Return the pathname corresponding to FILE and its ‘profile’.
It’s a convenience wrapper around ‘resolve’ (to avoid specifying the ‘profile’).

Package

nfiles

Source

nfiles.lisp (file)

Function: file-group PATH

Return PATH group name.

Package

nfiles

Source

pathname-helpers.lisp (file)

Writer

(setf file-group) (function)

Function: (setf file-group) NEW-GROUP PATH

Set PATH group to NEW-GROUP (a string).

Package

nfiles

Source

pathname-helpers.lisp (file)

Reader

file-group (function)

Function: file-user PATH

Return PATH owner name.

Package

nfiles

Source

pathname-helpers.lisp (file)

Writer

(setf file-user) (function)

Function: (setf file-user) NEW-USER PATH

Set PATH owner to NEW-USER (a string).

Package

nfiles

Source

pathname-helpers.lisp (file)

Reader

file-user (function)

Function: gpg-private-keys ()

Return list of private ‘gpg-key’s.

Package

nfiles/gpg

Source

gpg.lisp (file)

Function: nil-pathname-p PATHNAME

Return non-nil if PATHNAME is ‘uiop:*nil-pathname*’ or nil.

Package

nfiles

Source

pathname-helpers.lisp (file)

Function: parent PATH

Return the parent directory of PATH.

Package

nfiles

Source

pathname-helpers.lisp (file)

Function: pathname-type* PATHNAME

Like ‘pathname-type’ but return NIL instead of "" or :UNSPECIFIC.

Package

nfiles

Source

pathname-helpers.lisp (file)

Function: permissions PATH

Return a list of permissions as per ‘+permissions+’.

Package

nfiles

Source

pathname-helpers.lisp (file)

Writer

(setf permissions) (function)

Function: (setf permissions) PERMISSIONS PATH

Set the PERMISSIONS or PATH as per ‘+permissions+’.

Package

nfiles

Source

pathname-helpers.lisp (file)

Reader

permissions (function)


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

4.1.4 Generic functions

Generic Function: algorithm OBJECT
Generic Function: (setf algorithm) NEW-VALUE OBJECT
Package

nfiles/gpg

Methods
Method: algorithm (GPG-KEY gpg-key)

automatically generated reader method

Source

gpg.lisp (file)

Method: (setf algorithm) NEW-VALUE (GPG-KEY gpg-key)

automatically generated writer method

Source

gpg.lisp (file)

Generic Function: base-path OBJECT
Package

nfiles

Methods
Method: base-path (FILE file)

The pathname used by the ‘resolve’ method to yield the final path.

Source

nfiles.lisp (file)

Generic Function: creation-date OBJECT
Generic Function: (setf creation-date) NEW-VALUE OBJECT
Package

nfiles/gpg

Methods
Method: creation-date (GPG-KEY gpg-key)
Method: (setf creation-date) NEW-VALUE (GPG-KEY gpg-key)

Stored as in Unix format.

Source

gpg.lisp (file)

Generic Function: deserialize PROFILE FILE STREAM &key &allow-other-keys

Transform STREAM into a useful form ready to be manipulated on the Lisp side. See ‘serialize’ for the reverse action.

Package

nfiles

Source

nfiles.lisp (file)

Methods
Method: deserialize (PROFILE virtual-profile) (FILE file) STREAM &key
Method: deserialize (PROFILE profile) (FILE virtual-file) STREAM &key
Method: deserialize (PROFILE profile) (FILE lisp-file) STREAM &key
Method: deserialize (PROFILE profile) (FILE file) STREAM &key around

Don’t try deserialize if there is no file.
Handle errors gracefully. See ‘on-deserialization-error’.

Method: deserialize (PROFILE profile) (FILE file) STREAM &key
Generic Function: expiry-date OBJECT
Generic Function: (setf expiry-date) NEW-VALUE OBJECT
Package

nfiles/gpg

Methods
Method: expiry-date (GPG-KEY gpg-key)
Method: (setf expiry-date) NEW-VALUE (GPG-KEY gpg-key)

Stored as in Unix format.

Source

gpg.lisp (file)

Generic Function: fingerprint OBJECT
Generic Function: (setf fingerprint) NEW-VALUE OBJECT
Package

nfiles/gpg

Methods
Method: fingerprint (GPG-KEY gpg-key)

automatically generated reader method

Source

gpg.lisp (file)

Method: (setf fingerprint) NEW-VALUE (GPG-KEY gpg-key)

automatically generated writer method

Source

gpg.lisp (file)

Generic Function: key-id OBJECT
Generic Function: (setf key-id) NEW-VALUE OBJECT
Package

nfiles/gpg

Methods
Method: key-id (GPG-KEY gpg-key)

automatically generated reader method

Source

gpg.lisp (file)

Method: (setf key-id) NEW-VALUE (GPG-KEY gpg-key)

automatically generated writer method

Source

gpg.lisp (file)

Generic Function: key-length OBJECT
Generic Function: (setf key-length) NEW-VALUE OBJECT
Package

nfiles/gpg

Methods
Method: key-length (GPG-KEY gpg-key)

automatically generated reader method

Source

gpg.lisp (file)

Method: (setf key-length) NEW-VALUE (GPG-KEY gpg-key)

automatically generated writer method

Source

gpg.lisp (file)

Generic Function: keygrip OBJECT
Generic Function: (setf keygrip) NEW-VALUE OBJECT
Package

nfiles/gpg

Methods
Method: keygrip (GPG-KEY gpg-key)

automatically generated reader method

Source

gpg.lisp (file)

Method: (setf keygrip) NEW-VALUE (GPG-KEY gpg-key)

automatically generated writer method

Source

gpg.lisp (file)

Generic Function: name OBJECT
Generic Function: (setf name) NEW-VALUE OBJECT
Package

nfiles

Methods
Method: name (FILE file)
Method: (setf name) NEW-VALUE (FILE file)

Name used to identify the object in a human-readable manner.

Source

nfiles.lisp (file)

Method: name (PROFILE profile)
Method: (setf name) NEW-VALUE (PROFILE profile)

The name of the profile to refer it with.

Source

nfiles.lisp (file)

Generic Function: on-deserialization-error OBJECT
Generic Function: (setf on-deserialization-error) NEW-VALUE OBJECT
Package

nfiles

Methods
Method: on-deserialization-error (FILE file)
Method: (setf on-deserialization-error) NEW-VALUE (FILE file)

What to do on deserialization error.
The offending file may be backed up with the ‘backup’ function.
Or it may simply be deleted.
‘ask’ leaves the condition is unhandled, so unless you handle it it will prompt the debugger with the other options.

Source

nfiles.lisp (file)

Generic Function: on-external-modification OBJECT
Generic Function: (setf on-external-modification) NEW-VALUE OBJECT
Package

nfiles

Methods
Method: on-external-modification (FILE file)
Method: (setf on-external-modification) NEW-VALUE (FILE file)

Whether to reload or overwrite the file if it was modified since it was last loaded.

Source

nfiles.lisp (file)

Generic Function: on-read-error OBJECT
Generic Function: (setf on-read-error) NEW-VALUE OBJECT
Package

nfiles

Methods
Method: on-read-error (FILE file)
Method: (setf on-read-error) NEW-VALUE (FILE file)

What to do on file read error.
See ‘on-deserialization-error’ for the meaning of the different actions.

Source

nfiles.lisp (file)

Generic Function: profile OBJECT
Package

nfiles

Methods
Method: profile (FILE file)

The ‘profile’ of the ‘file’.
File expansion is performed against it. The profile is only set at instantiation time.

Source

nfiles.lisp (file)

Generic Function: read-file PROFILE FILE &key &allow-other-keys

Load FILE by calling ‘deserialize’ on a stream opened on the file. See ‘write-file’ for the reverse action.

Package

nfiles

Source

nfiles.lisp (file)

Methods
Method: read-file (PROFILE virtual-profile) (FILE file) &key

Don’t load anything when using the ‘virtual-profile’.

Method: read-file (PROFILE profile) (FILE virtual-file) &key

Don’t load anything for virtual files.

Method: read-file (PROFILE profile) (FILE gpg-file) &key

Decrypt FILE with GPG and return resulting stream. See ‘*gpg-default-recipient*’.

Method: read-file (PROFILE profile) (FILE file) &key

Open FILE and call ‘deserialize’ on its content.

Method: read-file (PROFILE profile) (FILE file) &key around

Don’t try to load the file if it does not exist.

Generic Function: read-handler OBJECT
Generic Function: (setf read-handler) NEW-VALUE OBJECT
Package

nfiles

Methods
Method: read-handler (FILE file)
Method: (setf read-handler) NEW-VALUE (FILE file)

Function of one argument, the condition that may be raised in the reader thread.

Source

nfiles.lisp (file)

Generic Function: resolve PROFILE FILE

Return the final expanded path for ‘file’ depending on its ‘profile’.
This method is meant to be specialized against the user-defined ‘profile’s and ‘file’s. See ‘expand’ for a convenience wrapper.

Package

nfiles

Source

nfiles.lisp (file)

Methods
Method: resolve (PROFILE profile) (FILE runtime-file)
Method: resolve (PROFILE profile) (FILE data-file)
Method: resolve (PROFILE profile) (FILE cache-file)
Method: resolve (PROFILE profile) (FILE config-file)
Method: resolve (PROFILE profile) (FILE gpg-file)
Method: resolve (PROFILE profile) (FILE lisp-file)
Method: resolve (PROFILE profile) (FILE file) around

Clean up the result before returning it.

Method: resolve (PROFILE profile) (FILE file)
Generic Function: serialize PROFILE FILE STREAM &key &allow-other-keys

Transform ‘file’ content meant to
be persisted to a file.

See ‘deserialize’ for the reverse action.

Package

nfiles

Source

nfiles.lisp (file)

Methods
Method: serialize (PROFILE read-only-profile) (FILE file) STREAM &key
Method: serialize (PROFILE profile) (FILE read-only-file) STREAM &key
Method: serialize (PROFILE profile) (FILE lisp-file) STREAM &key
Method: serialize (PROFILE profile) (FILE file) STREAM &key around
Method: serialize (PROFILE profile) (FILE file) STREAM &key
Generic Function: uids OBJECT
Generic Function: (setf uids) NEW-VALUE OBJECT
Package

nfiles/gpg

Methods
Method: uids (GPG-KEY gpg-key)

automatically generated reader method

Source

gpg.lisp (file)

Method: (setf uids) NEW-VALUE (GPG-KEY gpg-key)

automatically generated writer method

Source

gpg.lisp (file)

Generic Function: user-id OBJECT
Generic Function: (setf user-id) NEW-VALUE OBJECT
Package

nfiles/gpg

Methods
Method: user-id (GPG-UID gpg-uid)

automatically generated reader method

Source

gpg.lisp (file)

Method: (setf user-id) NEW-VALUE (GPG-UID gpg-uid)

automatically generated writer method

Source

gpg.lisp (file)

Generic Function: validity OBJECT
Generic Function: (setf validity) NEW-VALUE OBJECT
Package

nfiles/gpg

Methods
Method: validity (GPG-UID gpg-uid)

automatically generated reader method

Source

gpg.lisp (file)

Method: (setf validity) NEW-VALUE (GPG-UID gpg-uid)

automatically generated writer method

Source

gpg.lisp (file)

Generic Function: write-file PROFILE FILE &key DESTINATION &allow-other-keys

Persist FILE to disk.
DESTINATION is set by default to a staged pathname (using ‘uiop:with-staging-pathname’) which is renamed to the final name (the result ‘expand’ on FILE) if everything went well.
This guarantees that on error the original file is left untouched.

See ‘read-file’ for the reverse action.

Package

nfiles

Source

nfiles.lisp (file)

Methods
Method: write-file (PROFILE read-only-profile) (FILE file) &key DESTINATION

Don’t write anything when using the ‘read-only-profile’.

Method: write-file (PROFILE profile) (FILE read-only-file) &key DESTINATION

Don’t write anything for ‘read-only-file’.

Method: write-file (PROFILE profile) (FILE gpg-file) &key DESTINATION

Crypt to FILE with GPG. See ‘*gpg-default-recipient*’.

Method: write-file (PROFILE profile) (FILE file) &key DESTINATION

Write the result of ‘serialize’ to the ‘file’ path.

Method: write-file (PROFILE profile) (FILE file) &key DESTINATION around
Generic Function: write-handler OBJECT
Generic Function: (setf write-handler) NEW-VALUE OBJECT
Package

nfiles

Methods
Method: write-handler (FILE file)
Method: (setf write-handler) NEW-VALUE (FILE file)

Function of one argument, the condition that may be raised in the writer thread.

Source

nfiles.lisp (file)


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

4.1.5 Conditions

Condition: external-modification ()
Package

nfiles

Source

conditions.lisp (file)

Direct superclasses

error (condition)

Direct slots
Slot: path
Initargs

:path

Condition: process-error ()
Package

nfiles

Source

conditions.lisp (file)

Direct superclasses

subprocess-error (condition)

Direct slots
Slot: message
Initargs

:message


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

4.1.6 Classes

Class: cache-file ()

Like regular ‘file’ but set directory to ‘uiop:xdg-cache-home’

Package

nfiles

Source

nfiles.lisp (file)

Direct superclasses

file (class)

Direct methods

resolve (method)

Class: config-file ()

Like regular ‘file’ but set directory to ‘uiop:xdg-config-home’.

Package

nfiles

Source

nfiles.lisp (file)

Direct superclasses

file (class)

Direct methods

resolve (method)

Class: data-file ()

Like regular ‘file’ but set directory to ‘uiop:xdg-data-home’

Package

nfiles

Source

nfiles.lisp (file)

Direct superclasses

file (class)

Direct methods

resolve (method)

Class: file ()

The main object to manipulate and subclass.
The ‘profile’ slot can be used to drive the specializations of multiple ‘file’ methods. See ‘resolve’, ‘serialize’, ‘etc’.

The ‘name’ slot can be used to refer to ‘file’ objects in a human-readable fashion.

Package

nfiles

Source

nfiles.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses
Direct methods
Direct slots
Slot: base-path

The pathname used by the ‘resolve’ method to yield the final path.

Type

pathname

Initform

#p"."

Readers

base-path (generic function)

Slot: profile

The ‘profile’ of the ‘file’.
File expansion is performed against it. The profile is only set at instantiation time.

Type

nfiles:profile

Initargs

:profile

Initform

nfiles:*default-profile*

Readers

profile (generic function)

Slot: name

Name used to identify the object in a human-readable manner.

Type

string

Initargs

:name

Initform

""

Readers

name (generic function)

Writers

(setf name) (generic function)

Slot: read-handler

Function of one argument, the condition that may be raised in the reader thread.

Type

trivial-types:function-designator

Initargs

:read-handler

Initform

(function identity)

Readers

read-handler (generic function)

Writers

(setf read-handler) (generic function)

Slot: write-handler

Function of one argument, the condition that may be raised in the writer thread.

Type

trivial-types:function-designator

Initargs

:write-handler

Initform

(function identity)

Readers

write-handler (generic function)

Writers

(setf write-handler) (generic function)

Slot: on-external-modification

Whether to reload or overwrite the file if it was modified since it was last loaded.

Type

(member nfiles:ask nfiles:reload nfiles:overwrite)

Initargs

:on-external-modification

Initform

(quote nfiles:ask)

Readers

on-external-modification (generic function)

Writers

(setf on-external-modification) (generic function)

Slot: on-deserialization-error

What to do on deserialization error.
The offending file may be backed up with the ‘backup’ function.
Or it may simply be deleted.
‘ask’ leaves the condition is unhandled, so unless you handle it it will prompt the debugger with the other options.

Type

(member nfiles:ask nfiles:backup delete)

Initargs

:on-deserialization-error

Initform

(quote nfiles:ask)

Readers

on-deserialization-error (generic function)

Writers

(setf on-deserialization-error) (generic function)

Slot: on-read-error

What to do on file read error.
See ‘on-deserialization-error’ for the meaning of the different actions.

Type

(member nfiles:ask nfiles:backup delete)

Initargs

:on-read-error

Initform

(quote nfiles:ask)

Readers

on-read-error (generic function)

Writers

(setf on-read-error) (generic function)

Class: gpg-file ()

The file is automatically crypted and decrypted using the specified recipient key.
The ’.gpg’ extension is automatically added if missing.

Package

nfiles

Source

nfiles.lisp (file)

Direct superclasses

file (class)

Direct subclasses

gpg-lisp-file (class)

Direct methods
Class: gpg-key ()
Package

nfiles/gpg

Source

gpg.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: key-length
Initargs

:key-length

Readers

key-length (generic function)

Writers

(setf key-length) (generic function)

Slot: algorithm
Initargs

:algorithm

Readers

algorithm (generic function)

Writers

(setf algorithm) (generic function)

Slot: key-id
Initargs

:key-id

Readers

key-id (generic function)

Writers

(setf key-id) (generic function)

Slot: creation-date

Stored as in Unix format.

Initargs

:creation-date

Readers

creation-date (generic function)

Writers

(setf creation-date) (generic function)

Slot: expiry-date

Stored as in Unix format.

Initargs

:expiry-date

Readers

expiry-date (generic function)

Writers

(setf expiry-date) (generic function)

Slot: uids
Initargs

:uids

Readers

uids (generic function)

Writers

(setf uids) (generic function)

Slot: fingerprint
Initargs

:fingerprint

Readers

fingerprint (generic function)

Writers

(setf fingerprint) (generic function)

Slot: keygrip
Initargs

:keygrip

Readers

keygrip (generic function)

Writers

(setf keygrip) (generic function)

Class: gpg-lisp-file ()

The file is automatically crypted and decrypted using the specified recipient key.
The ’.lisp.gpg’ extension is automatically added if missing.

Package

nfiles

Source

nfiles.lisp (file)

Direct superclasses
Class: gpg-uid ()
Package

nfiles/gpg

Source

gpg.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: validity
Initargs

:validity

Readers

validity (generic function)

Writers

(setf validity) (generic function)

Slot: user-id
Initargs

:user-id

Readers

user-id (generic function)

Writers

(setf user-id) (generic function)

Class: lisp-file ()

Like regular ‘file’ but assume a ‘.lisp’ extension, even if not provided.

Package

nfiles

Source

nfiles.lisp (file)

Direct superclasses

file (class)

Direct subclasses

gpg-lisp-file (class)

Direct methods
Class: profile ()

This is the default profile.
Subclass this profile to make your own, possibly carrying more data.

‘file’ path expansion is specialized against its ‘profile’ slot throught the ‘resolve’ method.

Package

nfiles

Source

nfiles.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

read-only-profile (class)

Direct methods
Direct slots
Slot: name

The name of the profile to refer it with.

Type

string

Initargs

:name

Initform

"default"

Readers

name (generic function)

Writers

(setf name) (generic function)

Class: read-only-file ()

File that’s not written to on change.
Note that the file’s ‘content’ can still be modified in-memory.

Package

nfiles

Source

nfiles.lisp (file)

Direct superclasses

file (class)

Direct subclasses

virtual-file (class)

Direct methods
Class: read-only-profile ()

In this profile, files by default don’t get written to.

Package

nfiles

Source

nfiles.lisp (file)

Direct superclasses

profile (class)

Direct subclasses

virtual-profile (class)

Direct methods
Class: runtime-file ()

Like regular ‘file’ but set directory to ‘uiop:xdg-runtime-dir’

Package

nfiles

Source

nfiles.lisp (file)

Direct superclasses

file (class)

Direct methods

resolve (method)

Class: virtual-file ()

File that’s not read nor written to. It’s meant to handle data in-memory.

Note that if multiple ‘virtual-file’ expand to the same path, they share the same content.

To disable content-sharing for specific ‘file’, have their ‘resolve’ method return ‘uiop:*nil-pathname*’.

Package

nfiles

Source

nfiles.lisp (file)

Direct superclasses

read-only-file (class)

Direct methods
Class: virtual-profile ()

In this profile, files are neither read nor written to by default.

Package

nfiles

Source

nfiles.lisp (file)

Direct superclasses

read-only-profile (class)

Direct methods

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

4.2 Internal definitions


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

4.2.1 Constants

Constant: +permissions+
Package

nfiles

Source

pathname-helpers.lisp (file)


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

4.2.2 Special variables

Special Variable: *cache*

Internal ‘*cache*’ associating expanded paths with a dedicated ‘cache-entry’.

Package

nfiles

Source

nfiles.lisp (file)

Special Variable: *index*

Set of all ‘file’s objects.
It’s a weak hash table to that garbage-collected files are automatically removed.

Package

nfiles

Source

nfiles.lisp (file)

Special Variable: *timeout*

Time in seconds to wait for other write requests.

Package

nfiles

Source

nfiles.lisp (file)


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

4.2.3 Macros

Macro: run-thread NAME HANDLER &body BODY
Package

nfiles

Source

nfiles.lisp (file)


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

4.2.4 Functions

Function: auto-restarter RESTART

Call RESTART if valid.

Package

nfiles

Source

nfiles.lisp (file)

Function: cache-entry FILE &optional FORCE-READ

Files that expand to ‘uiop:*nil-pathname*’ have their own cache entry.

Package

nfiles

Source

nfiles.lisp (file)

Function: cache-entry-p OBJECT
Package

nfiles

Source

nfiles.lisp (file)

Function: cache-file-p OBJECT
Package

nfiles

Source

nfiles.lisp (file)

Function: call-with-gpg-file GPG-FILE OPTIONS FUN

Like ‘call-with-open-file’ but use ‘gpg’ to read and write to file. OPTIONS are as for ‘open”s ‘:direction’.
Other options are not supported. File is overwritten if it exists, while nothing is done if file is missing.

Package

nfiles/gpg

Source

gpg.lisp (file)

Function: clear-cache ()
Package

nfiles

Source

nfiles.lisp (file)

Function: config-file-p OBJECT
Package

nfiles

Source

nfiles.lisp (file)

Function: data-file-p OBJECT
Package

nfiles

Source

nfiles.lisp (file)

Function: drain-semaphore SEMAPHORE &optional TIMEOUT

Decrement the semaphore counter down to 0.
Return the number of decrements, or NIL if there was none.

Package

nfiles

Source

nfiles.lisp (file)

Function: expand-user-home STRING
Package

nfiles

Source

nfiles.lisp (file)

Function: file-key FILE
Package

nfiles

Source

nfiles.lisp (file)

Function: filep OBJECT
Package

nfiles

Source

nfiles.lisp (file)

Function: gpg-file-p OBJECT
Package

nfiles

Source

nfiles.lisp (file)

Function: gpg-key-p OBJECT
Package

nfiles/gpg

Source

gpg.lisp (file)

Function: gpg-lisp-file-p OBJECT
Package

nfiles

Source

nfiles.lisp (file)

Function: gpg-recipient FILE

Return the key of FILE’s recipient if any, ‘*gpg-default-recipient*’ otherwise. As second value the email.
As third value the name.

Package

nfiles/gpg

Source

gpg.lisp (file)

Function: gpg-uid-p OBJECT
Package

nfiles/gpg

Source

gpg.lisp (file)

Function: gpg-write STREAM GPG-FILE &optional RECIPIENT

Write STREAM to GPG-FILE using RECIPIENT key. If RECIPIENT is not provided, use default key.

Package

nfiles/gpg

Source

gpg.lisp (file)

Function: lisp-file-p OBJECT
Package

nfiles

Source

nfiles.lisp (file)

Function: maybe-xdg XDG-FUN PATH
Package

nfiles

Source

nfiles.lisp (file)

Function: parse-gpg-secret-keys-output OUTPUT-STRING

Return the list of sections as a list of strings.

Package

nfiles/gpg

Source

gpg.lisp (file)

Function: profilep OBJECT
Package

nfiles

Source

nfiles.lisp (file)

Function: read-new-value PROMPT

PROMPT takes no trailing colon nor trailing space.

Package

nfiles/gpg

Source

gpg.lisp (file)

Function: read-only-file-p OBJECT
Package

nfiles

Source

nfiles.lisp (file)

Function: read-only-profile-p OBJECT
Package

nfiles

Source

nfiles.lisp (file)

Function: run-program* COMMAND &key INPUT

Like ‘uiop:run-program’ but raise a ‘nfiles:process-error’ on error.

Package

nfiles/gpg

Source

gpg.lisp (file)

Function: runtime-file-p OBJECT
Package

nfiles

Source

nfiles.lisp (file)

Function: virtual-file-p OBJECT
Package

nfiles

Source

nfiles.lisp (file)

Function: virtual-profile-p OBJECT
Package

nfiles

Source

nfiles.lisp (file)

Function: worker-write FILE CACHE-ENTRY
Package

nfiles

Source

nfiles.lisp (file)

Function: write-cache-entry FILE ENTRY
Package

nfiles

Source

nfiles.lisp (file)


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

4.2.5 Generic functions

Generic Function: cached-value OBJECT
Generic Function: (setf cached-value) NEW-VALUE OBJECT
Package

nfiles

Methods
Method: cached-value (CACHE-ENTRY cache-entry)

automatically generated reader method

Source

nfiles.lisp (file)

Method: (setf cached-value) NEW-VALUE (CACHE-ENTRY cache-entry)

automatically generated writer method

Source

nfiles.lisp (file)

Generic Function: last-update OBJECT
Generic Function: (setf last-update) NEW-VALUE OBJECT
Package

nfiles

Methods
Method: last-update (CACHE-ENTRY cache-entry)
Method: (setf last-update) NEW-VALUE (CACHE-ENTRY cache-entry)

The date at which the cache entry was last updated.

Source

nfiles.lisp (file)

Generic Function: source-file OBJECT
Generic Function: (setf source-file) NEW-VALUE OBJECT
Package

nfiles

Methods
Method: source-file (CACHE-ENTRY cache-entry)
Method: (setf source-file) NEW-VALUE (CACHE-ENTRY cache-entry)

This is the ‘file’ object that was used to instantiate the entry’s ‘cached-value’.

Source

nfiles.lisp (file)

Generic Function: worker OBJECT
Generic Function: (setf worker) NEW-VALUE OBJECT
Package

nfiles

Methods
Method: worker (CACHE-ENTRY cache-entry)

automatically generated reader method

Source

nfiles.lisp (file)

Method: (setf worker) NEW-VALUE (CACHE-ENTRY cache-entry)

automatically generated writer method

Source

nfiles.lisp (file)

Generic Function: worker-notifier OBJECT
Generic Function: (setf worker-notifier) NEW-VALUE OBJECT
Package

nfiles

Methods
Method: worker-notifier (CACHE-ENTRY cache-entry)

automatically generated reader method

Source

nfiles.lisp (file)

Method: (setf worker-notifier) NEW-VALUE (CACHE-ENTRY cache-entry)

automatically generated writer method

Source

nfiles.lisp (file)


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

4.2.6 Classes

Class: cache-entry ()
Package

nfiles

Source

nfiles.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: source-file

This is the ‘file’ object that was used to instantiate the entry’s ‘cached-value’.

Type

nfiles:file

Initargs

:source-file

Initform

(error "source file must be given.")

Readers

source-file (generic function)

Writers

(setf source-file) (generic function)

Slot: last-update

The date at which the cache entry was last updated.

Type

integer

Initargs

:last-update

Initform

(get-universal-time)

Readers

last-update (generic function)

Writers

(setf last-update) (generic function)

Slot: cached-value
Initargs

:cached-value

Readers

cached-value (generic function)

Writers

(setf cached-value) (generic function)

Slot: worker
Type

(or null bordeaux-threads:thread)

Initargs

:worker

Readers

worker (generic function)

Writers

(setf worker) (generic function)

Slot: worker-notifier
Type

(or null bordeaux-threads:semaphore)

Initargs

:worker-notifier

Readers

worker-notifier (generic function)

Writers

(setf worker-notifier) (generic function)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   N  
Index Entry  Section

F
File, Lisp, nfiles.asd: The nfiles․asd file
File, Lisp, nfiles/conditions.lisp: The nfiles/conditions․lisp file
File, Lisp, nfiles/gpg.lisp: The nfiles/gpg․lisp file
File, Lisp, nfiles/nfiles.lisp: The nfiles/nfiles․lisp file
File, Lisp, nfiles/package.lisp: The nfiles/package․lisp file
File, Lisp, nfiles/pathname-helpers.lisp: The nfiles/pathname-helpers․lisp file

L
Lisp File, nfiles.asd: The nfiles․asd file
Lisp File, nfiles/conditions.lisp: The nfiles/conditions․lisp file
Lisp File, nfiles/gpg.lisp: The nfiles/gpg․lisp file
Lisp File, nfiles/nfiles.lisp: The nfiles/nfiles․lisp file
Lisp File, nfiles/package.lisp: The nfiles/package․lisp file
Lisp File, nfiles/pathname-helpers.lisp: The nfiles/pathname-helpers․lisp file

N
nfiles.asd: The nfiles․asd file
nfiles/conditions.lisp: The nfiles/conditions․lisp file
nfiles/gpg.lisp: The nfiles/gpg․lisp file
nfiles/nfiles.lisp: The nfiles/nfiles․lisp file
nfiles/package.lisp: The nfiles/package․lisp file
nfiles/pathname-helpers.lisp: The nfiles/pathname-helpers․lisp file

Jump to:   F   L   N  

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

A.2 Functions

Jump to:   (  
A   B   C   D   E   F   G   K   L   M   N   O   P   R   S   U   V   W  
Index Entry  Section

(
(setf algorithm): Exported generic functions
(setf algorithm): Exported generic functions
(setf cached-value): Internal generic functions
(setf cached-value): Internal generic functions
(setf content): Exported functions
(setf creation-date): Exported generic functions
(setf creation-date): Exported generic functions
(setf expiry-date): Exported generic functions
(setf expiry-date): Exported generic functions
(setf file-group): Exported functions
(setf file-user): Exported functions
(setf fingerprint): Exported generic functions
(setf fingerprint): Exported generic functions
(setf key-id): Exported generic functions
(setf key-id): Exported generic functions
(setf key-length): Exported generic functions
(setf key-length): Exported generic functions
(setf keygrip): Exported generic functions
(setf keygrip): Exported generic functions
(setf last-update): Internal generic functions
(setf last-update): Internal generic functions
(setf name): Exported generic functions
(setf name): Exported generic functions
(setf name): Exported generic functions
(setf on-deserialization-error): Exported generic functions
(setf on-deserialization-error): Exported generic functions
(setf on-external-modification): Exported generic functions
(setf on-external-modification): Exported generic functions
(setf on-read-error): Exported generic functions
(setf on-read-error): Exported generic functions
(setf permissions): Exported functions
(setf read-handler): Exported generic functions
(setf read-handler): Exported generic functions
(setf source-file): Internal generic functions
(setf source-file): Internal generic functions
(setf uids): Exported generic functions
(setf uids): Exported generic functions
(setf user-id): Exported generic functions
(setf user-id): Exported generic functions
(setf validity): Exported generic functions
(setf validity): Exported generic functions
(setf worker): Internal generic functions
(setf worker): Internal generic functions
(setf worker-notifier): Internal generic functions
(setf worker-notifier): Internal generic functions
(setf write-handler): Exported generic functions
(setf write-handler): Exported generic functions

A
algorithm: Exported generic functions
algorithm: Exported generic functions
all-files: Exported functions
auto-restarter: Internal functions

B
backup: Exported functions
base-path: Exported generic functions
base-path: Exported generic functions

C
cache-entry: Internal functions
cache-entry-p: Internal functions
cache-file-p: Internal functions
cached-value: Internal generic functions
cached-value: Internal generic functions
call-with-gpg-file: Internal functions
clear-cache: Internal functions
config-file-p: Internal functions
content: Exported functions
creation-date: Exported generic functions
creation-date: Exported generic functions

D
data-file-p: Internal functions
deserialize: Exported generic functions
deserialize: Exported generic functions
deserialize: Exported generic functions
deserialize: Exported generic functions
deserialize: Exported generic functions
deserialize: Exported generic functions
drain-semaphore: Internal functions

E
expand: Exported functions
expand-user-home: Internal functions
expiry-date: Exported generic functions
expiry-date: Exported generic functions

F
file-group: Exported functions
file-key: Internal functions
file-user: Exported functions
filep: Internal functions
fingerprint: Exported generic functions
fingerprint: Exported generic functions
Function, (setf content): Exported functions
Function, (setf file-group): Exported functions
Function, (setf file-user): Exported functions
Function, (setf permissions): Exported functions
Function, all-files: Exported functions
Function, auto-restarter: Internal functions
Function, backup: Exported functions
Function, cache-entry: Internal functions
Function, cache-entry-p: Internal functions
Function, cache-file-p: Internal functions
Function, call-with-gpg-file: Internal functions
Function, clear-cache: Internal functions
Function, config-file-p: Internal functions
Function, content: Exported functions
Function, data-file-p: Internal functions
Function, drain-semaphore: Internal functions
Function, expand: Exported functions
Function, expand-user-home: Internal functions
Function, file-group: Exported functions
Function, file-key: Internal functions
Function, file-user: Exported functions
Function, filep: Internal functions
Function, gpg-file-p: Internal functions
Function, gpg-key-p: Internal functions
Function, gpg-lisp-file-p: Internal functions
Function, gpg-private-keys: Exported functions
Function, gpg-recipient: Internal functions
Function, gpg-uid-p: Internal functions
Function, gpg-write: Internal functions
Function, lisp-file-p: Internal functions
Function, maybe-xdg: Internal functions
Function, nil-pathname-p: Exported functions
Function, parent: Exported functions
Function, parse-gpg-secret-keys-output: Internal functions
Function, pathname-type*: Exported functions
Function, permissions: Exported functions
Function, profilep: Internal functions
Function, read-new-value: Internal functions
Function, read-only-file-p: Internal functions
Function, read-only-profile-p: Internal functions
Function, run-program*: Internal functions
Function, runtime-file-p: Internal functions
Function, virtual-file-p: Internal functions
Function, virtual-profile-p: Internal functions
Function, worker-write: Internal functions
Function, write-cache-entry: Internal functions

G
Generic Function, (setf algorithm): Exported generic functions
Generic Function, (setf cached-value): Internal generic functions
Generic Function, (setf creation-date): Exported generic functions
Generic Function, (setf expiry-date): Exported generic functions
Generic Function, (setf fingerprint): Exported generic functions
Generic Function, (setf key-id): Exported generic functions
Generic Function, (setf key-length): Exported generic functions
Generic Function, (setf keygrip): Exported generic functions
Generic Function, (setf last-update): Internal generic functions
Generic Function, (setf name): Exported generic functions
Generic Function, (setf on-deserialization-error): Exported generic functions
Generic Function, (setf on-external-modification): Exported generic functions
Generic Function, (setf on-read-error): Exported generic functions
Generic Function, (setf read-handler): Exported generic functions
Generic Function, (setf source-file): Internal generic functions
Generic Function, (setf uids): Exported generic functions
Generic Function, (setf user-id): Exported generic functions
Generic Function, (setf validity): Exported generic functions
Generic Function, (setf worker): Internal generic functions
Generic Function, (setf worker-notifier): Internal generic functions
Generic Function, (setf write-handler): Exported generic functions
Generic Function, algorithm: Exported generic functions
Generic Function, base-path: Exported generic functions
Generic Function, cached-value: Internal generic functions
Generic Function, creation-date: Exported generic functions
Generic Function, deserialize: Exported generic functions
Generic Function, expiry-date: Exported generic functions
Generic Function, fingerprint: Exported generic functions
Generic Function, key-id: Exported generic functions
Generic Function, key-length: Exported generic functions
Generic Function, keygrip: Exported generic functions
Generic Function, last-update: Internal generic functions
Generic Function, name: Exported generic functions
Generic Function, on-deserialization-error: Exported generic functions
Generic Function, on-external-modification: Exported generic functions
Generic Function, on-read-error: Exported generic functions
Generic Function, profile: Exported generic functions
Generic Function, read-file: Exported generic functions
Generic Function, read-handler: Exported generic functions
Generic Function, resolve: Exported generic functions
Generic Function, serialize: Exported generic functions
Generic Function, source-file: Internal generic functions
Generic Function, uids: Exported generic functions
Generic Function, user-id: Exported generic functions
Generic Function, validity: Exported generic functions
Generic Function, worker: Internal generic functions
Generic Function, worker-notifier: Internal generic functions
Generic Function, write-file: Exported generic functions
Generic Function, write-handler: Exported generic functions
gpg-file-p: Internal functions
gpg-key-p: Internal functions
gpg-lisp-file-p: Internal functions
gpg-private-keys: Exported functions
gpg-recipient: Internal functions
gpg-uid-p: Internal functions
gpg-write: Internal functions

K
key-id: Exported generic functions
key-id: Exported generic functions
key-length: Exported generic functions
key-length: Exported generic functions
keygrip: Exported generic functions
keygrip: Exported generic functions

L
last-update: Internal generic functions
last-update: Internal generic functions
lisp-file-p: Internal functions

M
Macro, run-thread: Internal macros
Macro, with-file-content: Exported macros
Macro, with-gpg-file: Exported macros
Macro, with-paths: Exported macros
maybe-xdg: Internal functions
Method, (setf algorithm): Exported generic functions
Method, (setf cached-value): Internal generic functions
Method, (setf creation-date): Exported generic functions
Method, (setf expiry-date): Exported generic functions
Method, (setf fingerprint): Exported generic functions
Method, (setf key-id): Exported generic functions
Method, (setf key-length): Exported generic functions
Method, (setf keygrip): Exported generic functions
Method, (setf last-update): Internal generic functions
Method, (setf name): Exported generic functions
Method, (setf name): Exported generic functions
Method, (setf on-deserialization-error): Exported generic functions
Method, (setf on-external-modification): Exported generic functions
Method, (setf on-read-error): Exported generic functions
Method, (setf read-handler): Exported generic functions
Method, (setf source-file): Internal generic functions
Method, (setf uids): Exported generic functions
Method, (setf user-id): Exported generic functions
Method, (setf validity): Exported generic functions
Method, (setf worker): Internal generic functions
Method, (setf worker-notifier): Internal generic functions
Method, (setf write-handler): Exported generic functions
Method, algorithm: Exported generic functions
Method, base-path: Exported generic functions
Method, cached-value: Internal generic functions
Method, creation-date: Exported generic functions
Method, deserialize: Exported generic functions
Method, deserialize: Exported generic functions
Method, deserialize: Exported generic functions
Method, deserialize: Exported generic functions
Method, deserialize: Exported generic functions
Method, expiry-date: Exported generic functions
Method, fingerprint: Exported generic functions
Method, key-id: Exported generic functions
Method, key-length: Exported generic functions
Method, keygrip: Exported generic functions
Method, last-update: Internal generic functions
Method, name: Exported generic functions
Method, name: Exported generic functions
Method, on-deserialization-error: Exported generic functions
Method, on-external-modification: Exported generic functions
Method, on-read-error: Exported generic functions
Method, profile: Exported generic functions
Method, read-file: Exported generic functions
Method, read-file: Exported generic functions
Method, read-file: Exported generic functions
Method, read-file: Exported generic functions
Method, read-file: Exported generic functions
Method, read-handler: Exported generic functions
Method, resolve: Exported generic functions
Method, resolve: Exported generic functions
Method, resolve: Exported generic functions
Method, resolve: Exported generic functions
Method, resolve: Exported generic functions
Method, resolve: Exported generic functions
Method, resolve: Exported generic functions
Method, resolve: Exported generic functions
Method, serialize: Exported generic functions
Method, serialize: Exported generic functions
Method, serialize: Exported generic functions
Method, serialize: Exported generic functions
Method, serialize: Exported generic functions
Method, source-file: Internal generic functions
Method, uids: Exported generic functions
Method, user-id: Exported generic functions
Method, validity: Exported generic functions
Method, worker: Internal generic functions
Method, worker-notifier: Internal generic functions
Method, write-file: Exported generic functions
Method, write-file: Exported generic functions
Method, write-file: Exported generic functions
Method, write-file: Exported generic functions
Method, write-file: Exported generic functions
Method, write-handler: Exported generic functions

N
name: Exported generic functions
name: Exported generic functions
name: Exported generic functions
nil-pathname-p: Exported functions

O
on-deserialization-error: Exported generic functions
on-deserialization-error: Exported generic functions
on-external-modification: Exported generic functions
on-external-modification: Exported generic functions
on-read-error: Exported generic functions
on-read-error: Exported generic functions

P
parent: Exported functions
parse-gpg-secret-keys-output: Internal functions
pathname-type*: Exported functions
permissions: Exported functions
profile: Exported generic functions
profile: Exported generic functions
profilep: Internal functions

R
read-file: Exported generic functions
read-file: Exported generic functions
read-file: Exported generic functions
read-file: Exported generic functions
read-file: Exported generic functions
read-file: Exported generic functions
read-handler: Exported generic functions
read-handler: Exported generic functions
read-new-value: Internal functions
read-only-file-p: Internal functions
read-only-profile-p: Internal functions
resolve: Exported generic functions
resolve: Exported generic functions
resolve: Exported generic functions
resolve: Exported generic functions
resolve: Exported generic functions
resolve: Exported generic functions
resolve: Exported generic functions
resolve: Exported generic functions
resolve: Exported generic functions
run-program*: Internal functions
run-thread: Internal macros
runtime-file-p: Internal functions

S
serialize: Exported generic functions
serialize: Exported generic functions
serialize: Exported generic functions
serialize: Exported generic functions
serialize: Exported generic functions
serialize: Exported generic functions
source-file: Internal generic functions
source-file: Internal generic functions

U
uids: Exported generic functions
uids: Exported generic functions
user-id: Exported generic functions
user-id: Exported generic functions

V
validity: Exported generic functions
validity: Exported generic functions
virtual-file-p: Internal functions
virtual-profile-p: Internal functions

W
with-file-content: Exported macros
with-gpg-file: Exported macros
with-paths: Exported macros
worker: Internal generic functions
worker: Internal generic functions
worker-notifier: Internal generic functions
worker-notifier: Internal generic functions
worker-write: Internal functions
write-cache-entry: Internal functions
write-file: Exported generic functions
write-file: Exported generic functions
write-file: Exported generic functions
write-file: Exported generic functions
write-file: Exported generic functions
write-file: Exported generic functions
write-handler: Exported generic functions
write-handler: Exported generic functions

Jump to:   (  
A   B   C   D   E   F   G   K   L   M   N   O   P   R   S   U   V   W  

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

A.3 Variables

Jump to:   *   +  
A   B   C   E   F   K   L   M   N   O   P   R   S   U   V   W  
Index Entry  Section

*
*cache*: Internal special variables
*default-profile*: Exported special variables
*gpg-default-recipient*: Exported special variables
*gpg-program*: Exported special variables
*index*: Internal special variables
*timeout*: Internal special variables

+
+permissions+: Internal constants

A
algorithm: Exported classes

B
base-path: Exported classes

C
cached-value: Internal classes
Constant, +permissions+: Internal constants
creation-date: Exported classes

E
expiry-date: Exported classes

F
fingerprint: Exported classes

K
key-id: Exported classes
key-length: Exported classes
keygrip: Exported classes

L
last-update: Internal classes

M
message: Exported conditions

N
name: Exported classes
name: Exported classes

O
on-deserialization-error: Exported classes
on-external-modification: Exported classes
on-read-error: Exported classes

P
path: Exported conditions
profile: Exported classes

R
read-handler: Exported classes

S
Slot, algorithm: Exported classes
Slot, base-path: Exported classes
Slot, cached-value: Internal classes
Slot, creation-date: Exported classes
Slot, expiry-date: Exported classes
Slot, fingerprint: Exported classes
Slot, key-id: Exported classes
Slot, key-length: Exported classes
Slot, keygrip: Exported classes
Slot, last-update: Internal classes
Slot, message: Exported conditions
Slot, name: Exported classes
Slot, name: Exported classes
Slot, on-deserialization-error: Exported classes
Slot, on-external-modification: Exported classes
Slot, on-read-error: Exported classes
Slot, path: Exported conditions
Slot, profile: Exported classes
Slot, read-handler: Exported classes
Slot, source-file: Internal classes
Slot, uids: Exported classes
Slot, user-id: Exported classes
Slot, validity: Exported classes
Slot, worker: Internal classes
Slot, worker-notifier: Internal classes
Slot, write-handler: Exported classes
source-file: Internal classes
Special Variable, *cache*: Internal special variables
Special Variable, *default-profile*: Exported special variables
Special Variable, *gpg-default-recipient*: Exported special variables
Special Variable, *gpg-program*: Exported special variables
Special Variable, *index*: Internal special variables
Special Variable, *timeout*: Internal special variables

U
uids: Exported classes
user-id: Exported classes

V
validity: Exported classes

W
worker: Internal classes
worker-notifier: Internal classes
write-handler: Exported classes

Jump to:   *   +  
A   B   C   E   F   K   L   M   N   O   P   R   S   U   V   W  

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

A.4 Data types

Jump to:   C   D   E   F   G   L   N   P   R   S   V  
Index Entry  Section

C
cache-entry: Internal classes
cache-file: Exported classes
Class, cache-entry: Internal classes
Class, cache-file: Exported classes
Class, config-file: Exported classes
Class, data-file: Exported classes
Class, file: Exported classes
Class, gpg-file: Exported classes
Class, gpg-key: Exported classes
Class, gpg-lisp-file: Exported classes
Class, gpg-uid: Exported classes
Class, lisp-file: Exported classes
Class, profile: Exported classes
Class, read-only-file: Exported classes
Class, read-only-profile: Exported classes
Class, runtime-file: Exported classes
Class, virtual-file: Exported classes
Class, virtual-profile: Exported classes
Condition, external-modification: Exported conditions
Condition, process-error: Exported conditions
config-file: Exported classes

D
data-file: Exported classes

E
external-modification: Exported conditions

F
file: Exported classes

G
gpg-file: Exported classes
gpg-key: Exported classes
gpg-lisp-file: Exported classes
gpg-uid: Exported classes

L
lisp-file: Exported classes

N
nfiles: The nfiles system
nfiles: The nfiles package
nfiles/gpg: The nfiles/gpg package

P
Package, nfiles: The nfiles package
Package, nfiles/gpg: The nfiles/gpg package
process-error: Exported conditions
profile: Exported classes

R
read-only-file: Exported classes
read-only-profile: Exported classes
runtime-file: Exported classes

S
System, nfiles: The nfiles system

V
virtual-file: Exported classes
virtual-profile: Exported classes

Jump to:   C   D   E   F   G   L   N   P   R   S   V