This is the clache Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Nov 06 12:49:11 2023 GMT+0.
The main system appears first, followed by any subsystem dependency.
clacheOlexiy Zamkoviy
Tomohiro Matsuyama
LLGPL
alexandria (system).
trivial-garbage (system).
babel (system).
ironclad (system).
cl-fad (system).
cl-store (system).
cl-annot (system).
cl-syntax (system).
cl-syntax-annot (system).
src (module).
Modules are listed depth-first from the system components tree.
clache/srcclache (system).
package.lisp (file).
utils.lisp (file).
protocol.lisp (file).
stores (module).
api.lisp (file).
clache/src/storesprotocol.lisp (file).
src (module).
memory.lisp (file).
file.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
clache/clache.asdclache/src/package.lispclache/src/utils.lispclache/src/protocol.lispclache/src/stores/memory.lispclache/src/stores/file.lispclache/src/api.lispclache/src/utils.lisppackage.lisp (file).
src (module).
md5-hex-string (function).
object-to-string (function).
symbol-fqn (function).
clache/src/protocol.lisputils.lisp (file).
src (module).
cache-key-to-string (generic function).
clear-cache (generic function).
delete-cache (generic function).
load-cache (generic function).
never-expire-p (function).
store (class).
store-cache (generic function).
expire (type).
clache/src/stores/memory.lispstores (module).
clear-cache (method).
delete-cache (method).
load-cache (method).
memory-store (class).
store-cache (method).
hash-table-of (reader method).
clache/src/stores/file.lispmemory.lisp (file).
stores (module).
clear-cache (method).
delete-cache (method).
file-store (class).
load-cache (method).
store-cache (method).
cache-path (function).
directory-of (reader method).
clache/src/api.lispstores (module).
src (module).
cache (macro).
clrcache (function).
getcache (function).
(setf getcache) (function).
remcache (function).
setcache (function).
with-cache (macro).
with-inline-cache (macro).
Packages are listed by definition order.
clachecommon-lisp.
cache (macro).
cache-key-to-string (generic function).
clear-cache (generic function).
clrcache (function).
delete-cache (generic function).
file-store (class).
getcache (function).
(setf getcache) (function).
load-cache (generic function).
memory-store (class).
never-expire-p (function).
remcache (function).
setcache (function).
store (class).
store-cache (generic function).
with-cache (macro).
with-inline-cache (macro).
cache-path (function).
directory-of (generic reader).
expire (type).
hash-table-of (generic reader).
md5-hex-string (function).
object-to-string (function).
symbol-fqn (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Annotation for caching functions with their arguments. This should
be used with CL-ANNOT. KEYARGS is a form or a list of form for making
a cache key. To make cache keys distinct as to the function, you may
add a keyword or a symbol into KEYARGS. See also WITH-CACHE.
Example:
@cache ((:f x y z))
(defun f (x y z)
...)
;; Remove a cache of F
(remcache ’(:f 1 2 3))
If a cache indicated by KEY exists, this just returns the cache
value without evaluating BODY. Otherwise, this evaluates BODY and
stores the evaluated value into STORE with KEY and EXPIRE. KEY is a
form that an evaluated value indicates the cache key.
Example:
(defun f (x)
(with-cache (x *store*)
(very-complex-computation x)))
Same as WITH-CACHE, except that an inline memory store will be used as a cache store. TEST is a function to test hash table keys of the memory store. WEAKNESS specifies the hash table is weak-hash-table or not.
Remove all caches from STORE. The return value is undefined.
Retrieve a cache value from STORE indicated by KEY and return values of the cache value and a boolean whether the cache exists in STORE. The cache value will be NIL if such the cache doesn’t exist. For example, (getcache "not-existed-cache") will return NIL, NIL.
Return T if EXPIRE represents caches will never be expired.
Remove a cache from STORE indicated by KEY. If the cache has been successfully removed, this function returns T, otherwise returns NIL.
Store a cache VALUE into STORE with KEY and EXPIRE. EXPIRE is an expiration time in seconds. If EXPIRE is NIL, the cache will never be expired. The return value is VALUE that has been stored.
This function converts any type of KEY into
string. This should be an injective function, meaning this should not
lose the information about key.
Remove all caches from STORE. Any object can be returned.
file-store)) ¶memory-store)) ¶Remove a cache indicated by KEY from STORE. If the
cache has been successfully removed, this function should return T,
otherwise should return NIL.
file-store)) ¶memory-store)) ¶Try to retrieve a cache indicated by KEY from STORE
and return values of the cache value and a boolean whether the cache
exists in STORE. The cache value should be NIL if such the cache
doesn’t exist or has been expired.
file-store)) ¶memory-store)) ¶Store a cache VALUE with KEY into STORE. EXPIRE is
a keep time in seconds. If EXPIRE is NIL, the cache will never
expired. This function should return the value that has been
stored.
file-store) expire) ¶memory-store) expire) ¶common-lisp.
(cl-annot.slot::required-argument :directory)
:directory
This slot is read-only.
common-lisp.
(make-hash-table :test (function equal))
:hash-table
This slot is read-only.
An abstract class of stores. All stores must inherit from this class.
Return a MD5 digest of STRING in hex string.
Convert OBJECT into string by using PRINC-TO-STRING if OBJECT is not a symbol, or by using SYMBOL-FQN if OBJECT is a symbol.
Return a fully qualified name of SYMBOL in string. For example, (symbol-fqn ’if) will return "COMMON-LISP:IF".
file-store)) ¶automatically generated reader method
memory-store)) ¶automatically generated reader method
| Jump to: | (
C D F G H L M N O R S W |
|---|
| Jump to: | (
C D F G H L M N O R S W |
|---|
| Jump to: | D H S |
|---|
| Index Entry | Section | ||
|---|---|---|---|
| | |||
| D | |||
directory: | Public classes | ||
| | |||
| H | |||
hash-table: | Public classes | ||
| | |||
| S | |||
Slot, directory: | Public classes | ||
Slot, hash-table: | Public classes | ||
| | |||
| Jump to: | D H S |
|---|
| Jump to: | A C E F M P S T U |
|---|
| Jump to: | A C E F M P S T U |
|---|