memento.config
Memoization library config.
Contains global settings that manipulate the cache mechanisms. See doc strings.
Contains conf settings as vars.
Also contains documented definitions of standard options of cache config.
Memoization library config. Contains global settings that manipulate the cache mechanisms. See doc strings. Contains conf settings as vars. Also contains documented definitions of standard options of cache config.
bind-modeclj
Function bind setting, defaults to :new. It governs what the bind will do if you try to bind a cache to a function that is already cached, e.g. what happens when memo is called multiple times on same Var. Options are:
- :keep, keeps old cache binding
- :new, keeps the new cache binding
- :stack, stacks the caches, so the new binding wraps the older cached function
Function bind setting, defaults to :new. It governs what the bind will do if you try to bind a cache to a function that is already cached, e.g. what happens when memo is called multiple times on same Var. Options are: - :keep, keeps old cache binding - :new, keeps the new cache binding - :stack, stacks the caches, so the new binding wraps the older cached function
cacheclj
The key extracted from object/var meta and used as cache configuration when 1-arg memo is called or ns-scan based mounting is performed.
The key extracted from object/var meta and used as cache configuration when 1-arg memo is called or ns-scan based mounting is performed.
caffeineclj
Cache setting value, type name of Caffeine cache implementation
Cache setting value, type name of Caffeine cache implementation
concurrencycljdeprecated
DEPRECATED: it does nothing in Caffeine implementation
DEPRECATED: it does nothing in Caffeine implementation
enabled?clj
If false, then all cache attach operations create a cache that does no caching (changing this value doesn't affect caches already created).
Initially has the value of java property memento.enabled (defaulting to true).
If false, then all cache attach operations create a cache that does no caching (changing this value doesn't affect caches already created). Initially has the value of java property `memento.enabled` (defaulting to true).
evt-fnclj
Function bind setting, a function that is invoked when any event is fired at the function.
(fn [mnt-point event] void)
Useful generally to push data into the related cache, the mnt-point parameter implement MountPoint protocol so you can invoke memo-add! and such on it. The event can be any data, it's probably best to come up with a format that enables the functions that receive the event to be able to tell them apart.
Function bind setting, a function that is invoked when any event is fired at the function. (fn [mnt-point event] void) Useful generally to push data into the related cache, the mnt-point parameter implement MountPoint protocol so you can invoke memo-add! and such on it. The event can be any data, it's probably best to come up with a format that enables the functions that receive the event to be able to tell them apart.
fadeclj
Cache and Function bind setting, a duration.
Specifies that each entry should be automatically removed from the cache once a fixed duration has elapsed after the entry's creation, the most recent replacement of its value, or its last access. Access time is reset by all cache read and write operations.
Duration is specified by a number (of seconds) or a vector of a number and unit keyword. So fade of 10 or [10 :s] is the same. See 'timeunits' var.
Cache and Function bind setting, a duration. Specifies that each entry should be automatically removed from the cache once a fixed duration has elapsed after the entry's creation, the most recent replacement of its value, or its last access. Access time is reset by all cache read and write operations. Duration is specified by a number (of seconds) or a vector of a number and unit keyword. So fade of 10 or [10 :s] is the same. See 'timeunits' var.
guavacljdeprecated
DEPRECATED: Cache setting value, now points to caffeine implementation
DEPRECATED: Cache setting value, now points to caffeine implementation
idclj
Function bind setting.
Id of the function bind. If you're memoizing a Var, this defaults to stringified var name, otherwise the ID is the function itself.
This is useful to specify when you're using Cache implementation that stores data outside JVM, as they often need a name for each function's cache.
Function bind setting. Id of the function bind. If you're memoizing a Var, this defaults to stringified var name, otherwise the ID is the function itself. This is useful to specify when you're using Cache implementation that stores data outside JVM, as they often need a name for each function's cache.
initial-capacityclj
Cache setting, supported by: caffeine, an int.
Sets the minimum total size for the internal hash tables. Providing a large enough estimate at construction time avoids the need for expensive resizing operations later, but setting this value unnecessarily high wastes memory.
Cache setting, supported by: caffeine, an int. Sets the minimum total size for the internal hash tables. Providing a large enough estimate at construction time avoids the need for expensive resizing operations later, but setting this value unnecessarily high wastes memory.
key-fnclj
Cache and function bind setting, a function to be used to calculate the cache key (fn [f-args] key).
Cache key affects what is considered the 'same' argument list for a function and it will affect caching in that manner.
If both function bind and cache have this setting, then function bind key-fn is applied first.
It's a function of 1 argument, the seq of function arguments. If not provided it defaults to identity.
Cache and function bind setting, a function to be used to calculate the cache key (fn [f-args] key). Cache key affects what is considered the 'same' argument list for a function and it will affect caching in that manner. If both function bind and cache have this setting, then function bind key-fn is applied first. It's a function of 1 argument, the seq of function arguments. If not provided it defaults to identity.
key-fn*clj
Function bind setting, works same as key-fn but the provided function will receive all arguments that the original function does. If both key-fn and key-fn* are provided, key-fn is used.
Function bind setting, works same as key-fn but the provided function will receive all arguments that the original function does. If both key-fn and key-fn* are provided, key-fn is used.
mountclj
The key extracted from object/var meta and used as mount configuration when 1-arg memo is called or ns-scan based mounting is performed.
The key extracted from object/var meta and used as mount configuration when 1-arg memo is called or ns-scan based mounting is performed.
noneclj
Cache setting value, type name of noop cache implementation
Cache setting value, type name of noop cache implementation
reload-guards?clj
If true, then whenever a function cached with tags is garbage collected (e.g. after a namespace reload in REPL), a cleanup is done of global tags map. Can be turned off if you don't intend to reload namespaces or do other actions that would GC cached function instances.
Initially has the value of java property memento.reloadable (defaulting to true).
If true, then whenever a function cached with tags is garbage collected (e.g. after a namespace reload in REPL), a cleanup is done of global tags map. Can be turned off if you don't intend to reload namespaces or do other actions that would GC cached function instances. Initially has the value of java property `memento.reloadable` (defaulting to true).
ret-ex-fnclj
Cache and function bind setting, a function that is ran to process the throwable thrown by the function, (fn [fn-args throwable] throwable).
Cache and function bind setting, a function that is ran to process the throwable thrown by the function, (fn [fn-args throwable] throwable).
ret-fnclj
Cache and function bind setting, a function that is ran to process the return of the function, before it's memoized, (fn [fn-args ret-value] transformed-value).
It can provide some generic transformation facility, but more importantly, it can wrap specific return values in 'do-not-cache' object, that prevents caching or wrap with tagged IDs.
Cache and function bind setting, a function that is ran to process the return of the function, before it's memoized, (fn [fn-args ret-value] transformed-value). It can provide some generic transformation facility, but more importantly, it can wrap specific return values in 'do-not-cache' object, that prevents caching or wrap with tagged IDs.
seedclj
Function bind setting, a map of cache keys to values that will be preloaded when cache is bound.
Function bind setting, a map of cache keys to values that will be preloaded when cache is bound.
size<clj
Cache setting, supported by: caffeine, a long.
Specifies the maximum number of entries the cache may contain. Some implementations might evict entries even before the number of entries reaches the limit.
Cache setting, supported by: caffeine, a long. Specifies the maximum number of entries the cache may contain. Some implementations might evict entries even before the number of entries reaches the limit.
tagsclj
Function bind setting.
List of tags for this memoized bind.
Function bind setting. List of tags for this memoized bind.
timeunitsclj
Timeunits keywords, corresponds with Durations class.
Timeunits keywords, corresponds with Durations class.
ttlclj
Cache and Function bind setting, a duration.
Specifies that each entry should be automatically removed from the cache once a duration has elapsed after the entry's creation, or the most recent replacement of its value via a put.
Duration is specified by a number (of seconds) or a vector of a number and unit keyword. So ttl of 10 or [10 :s] is the same. See 'timeunits' var.
Cache and Function bind setting, a duration. Specifies that each entry should be automatically removed from the cache once a duration has elapsed after the entry's creation, or the most recent replacement of its value via a put. Duration is specified by a number (of seconds) or a vector of a number and unit keyword. So ttl of 10 or [10 :s] is the same. See 'timeunits' var.
typeclj
Cache setting, type of cache or region that will be instantiated, a keyword.
The library has two built-ins:
- memento.core/none
- memento.core/caffeine
If not specified the caches created default to default-type.
Cache setting, type of cache or region that will be instantiated, a keyword. The library has two built-ins: - memento.core/none - memento.core/caffeine If not specified the caches created default to *default-type*.
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close