Liking cljdoc? Tell your friends :D

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

assoc_k_vclj/s

(assoc_k_v this t_m impls metadata k v)

Overrides ITransientAssociative.-assoc! (assoc!). Expected fn signature: (fn [this t_m impls metadata k v] ...) Should return: The updated this TransientPolyMap instance.

Overrides `ITransientAssociative.-assoc!` (assoc!).
Expected fn signature: `(fn [this t_m impls metadata k v] ...)`
Should return: The updated `this` TransientPolyMap instance.
sourceraw docstring

conj!_entryclj/s

(conj!_entry this t_m impls metadata entry)

Overrides ITransientCollection.-conj! (conj!). Expected fn signature: (fn [this t_m impls metadata entry] ...) Should return: The updated this TransientPolyMap instance.

Overrides `ITransientCollection.-conj!` (conj!).
Expected fn signature: `(fn [this t_m impls metadata entry] ...)`
Should return: The updated `this` TransientPolyMap instance.
sourceraw docstring

countclj/s

(count this t_m impls metadata)

Overrides ICounted.-count on transient. Expected fn signature: (fn [this t_m impls metadata] ...) Should return: The integer count of items in the transient map.

Overrides `ICounted.-count` on transient.
Expected fn signature: `(fn [this t_m impls metadata] ...)`
Should return: The integer count of items in the transient map.
sourceraw docstring

metaclj/s

(meta this t_m impls metadata)

Overrides IMeta.-meta on transient. Expected fn signature: (fn [this t_m impls metadata] ...) Should return: The metadata map associated with the transient map.

Overrides `IMeta.-meta` on transient.
Expected fn signature: `(fn [this t_m impls metadata] ...)`
Should return: The metadata map associated with the transient map.
sourceraw docstring

persistentclj/s

(persistent this t_m impls metadata)

Overrides ITransientCollection.-persistent!. Expected fn signature: (fn [this t_m impls metadata] ...) Should return: The new persistent PolyMap instance.

Overrides `ITransientCollection.-persistent!`.
Expected fn signature: `(fn [this t_m impls metadata] ...)`
Should return: The new persistent `PolyMap` instance.
sourceraw docstring

valAt_kclj/s

(valAt_k this t_m impls metadata k)

Overrides ILookup.-lookup (get with 1 key argument) on transient. Expected fn signature: (fn [this t_m impls metadata k] ...) Should return: The value associated with k, or nil if not found.

Overrides `ILookup.-lookup` (get with 1 key argument) on transient.
Expected fn signature: `(fn [this t_m impls metadata k] ...)`
Should return: The value associated with `k`, or nil if not found.
sourceraw docstring

valAt_k_nfclj/s

(valAt_k_nf this t_m impls metadata k nf)

Overrides ILookup.-lookup (get with key and nf) on transient. Expected fn signature: (fn [this t_m impls metadata k nf] ...) Should return: The value associated with k, or the nf value.

Overrides `ILookup.-lookup` (get with key and nf) on transient.
Expected fn signature: `(fn [this t_m impls metadata k nf] ...)`
Should return: The value associated with `k`, or the `nf` value.
sourceraw docstring

withMeta_metaclj/s

(withMeta_meta this t_m impls metadata new-meta)

Overrides IWithMeta.-with-meta on transient. Note: -with-meta on transients returns a persistent collection in CLJS. Expected fn signature: (fn [this t_m impls metadata new-meta] ...) Should return: A new persistent PolyMap instance with the metadata applied.

Overrides `IWithMeta.-with-meta` on transient.
Note: `-with-meta` on transients returns a *persistent* collection in CLJS.
Expected fn signature: `(fn [this t_m impls metadata new-meta] ...)`
Should return: A new persistent `PolyMap` instance with the metadata applied.
sourceraw docstring

without_kclj/s

(without_k this t_m impls metadata k)

Overrides ITransientMap.-dissoc! (dissoc!). Expected fn signature: (fn [this t_m impls metadata k] ...) Should return: The updated this TransientPolyMap instance.

Overrides `ITransientMap.-dissoc!` (dissoc!).
Expected fn signature: `(fn [this t_m impls metadata k] ...)`
Should return: The updated `this` TransientPolyMap instance.
sourceraw docstring

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

× close