Liking cljdoc? Tell your friends :D

com.jolygon.poly-map.api-0.impl

clj

Internal implementation details for PolyMap. Provides the PolyMap and TransientPolyMap deftypes and related protocols. Users should generally prefer the API functions in 'com.jolygon.poly-map.api-0' or subsequent API versions, and use the impl keys defined in 'com.jolygon.poly-map.api-0.keys' and 'com.jolygon.poly-map.trans.keys'. This namespace is subject to change.

Internal implementation details for PolyMap.
Provides the PolyMap and TransientPolyMap deftypes and related protocols.
Users should generally prefer the API functions in 'com.jolygon.poly-map.api-0'
or subsequent API versions, and use the impl keys defined in
'com.jolygon.poly-map.api-0.keys' and 'com.jolygon.poly-map.trans.keys'.
This namespace is subject to change.
cljs

Internal implementation details for PolyMap (ClojureScript). Provides the PolyMap and TransientPolyMap deftypes and related protocols. Users should generally prefer the API functions in 'com.jolygon.poly-map.api-0' or subsequent API versions, and use the implementation keys defined in 'com.jolygon.poly-map.api-0.keys' and 'com.jolygon.poly-map.api-0.trans.keys'.

This namespace is subject to change.

Internal implementation details for PolyMap (ClojureScript).
Provides the PolyMap and TransientPolyMap deftypes and related protocols.
Users should generally prefer the API functions in 'com.jolygon.poly-map.api-0'
or subsequent API versions, and use the implementation keys defined in
'com.jolygon.poly-map.api-0.keys' and 'com.jolygon.poly-map.api-0.trans.keys'.

This namespace is subject to change.
raw docstring

com.jolygon.poly-map.api-0.keys

This ns is mostly just for documentation and for providing an alias.

Defines standard keyword keys used in the implementations ('impls') map of a persistent PolyMap to override default map behaviors.

Each var defined here holds the actual namespaced keyword as its value (e.g., get_k evaluates to ::get_k in this ns). The documentation for the override is attached as metadata to the var.

Override functions associated with these keywords receive the following arguments:

  • this The PolyMap instance itself.
  • m The underlying persistent data collection.
  • impls The persistent implementations map itself.
  • metadata The persistent metadata map of the PolyMap instance. Followed by operation-specific arguments like k, v, f, init, etc.

Override functions are generally expected to return the final result that the corresponding Clojure interface method would return (e.g., a new PolyMap instance for assoc/dissoc, a value for get, a boolean for containsKey?). When returning a new PolyMap instance, ensure it's properly constructed, often using com.jolygon.poly-map.api-0/make-poly-map or similar internal constructors if needed, preserving implementations and metadata appropriately.

This ns is mostly just for documentation and for providing an alias.

Defines standard keyword keys used in the implementations ('impls') map
of a persistent PolyMap to override default map behaviors.

Each var defined here holds the actual namespaced keyword as its value
(e.g., `get_k` evaluates to `::get_k` in this ns). The documentation for
the override is attached as metadata to the var.

Override functions associated with these keywords receive the following
arguments:
- this       The PolyMap instance itself.
- m       The underlying persistent data collection.
- impls      The persistent implementations map itself.
- metadata   The persistent metadata map of the PolyMap instance.
Followed by operation-specific arguments like k, v, f, init, etc.

Override functions are generally expected to return the final result
that the corresponding Clojure interface method would return (e.g., a new
PolyMap instance for assoc/dissoc, a value for get, a boolean for containsKey?).
When returning a new PolyMap instance, ensure it's properly constructed,
often using `com.jolygon.poly-map.api-0/make-poly-map` or similar internal
constructors if needed, preserving implementations and metadata appropriately.
raw docstring

com.jolygon.poly-map.api-0.trans.keys

This ns is mostly just for documentation and for providing an alias.

Defines standard keyword keys used in the implementations ('impls') map of a TransientPolyMap to override default transient map behaviors.

Each var defined here holds the actual namespaced keyword as its value (e.g., assoc_k_v evaluates to ::assoc_k_v in this ns). The documentation for the override is attached as metadata to the var.

Example expected signature for ::assoc_k_v: (fn [this t_m impls metadata k v] ...)

Overrides for mutating operations (assoc!, conj!, dissoc!) should generally return the this (the TransientPolyMap instance) to allow chaining. The override for persistent! should return the new persistent PolyMap with all internal maps persisted as well. Overrides for read operations should return the requested value.

This ns is mostly just for documentation and for providing an alias.

Defines standard keyword keys used in the implementations ('impls') map of a
TransientPolyMap to override default transient map behaviors.

Each var defined here holds the actual namespaced keyword as its value
(e.g., `assoc_k_v` evaluates to `::assoc_k_v` in this ns).
The documentation for the override is attached as metadata to the var.

Example expected signature for `::assoc_k_v`:
`(fn [this t_m impls metadata k v] ...)`

Overrides for mutating operations (`assoc!`, `conj!`, `dissoc!`)
should generally return the `this` (the TransientPolyMap instance) to allow chaining.
The override for `persistent!` should return the new persistent `PolyMap` with all
internal maps persisted as well.
Overrides for read operations should return the requested value.
raw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close