Function: consult--dynamic-collection

consult--dynamic-collection is a natively compiled function defined in consult.el.

Signature

(consult--dynamic-collection FUN &key MIN-INPUT THROTTLE DEBOUNCE TRANSFORM HIGHLIGHT)

Documentation

Dynamic candidate computation pipeline.

FUN computes the candidates. It takes either a single input argument or an input argument and a callback function, if computed candidates should be updated incrementally. The callback function must not be called after FUN has returned. MIN-INPUT is passed to consult--async-min-input. THROTTLE and DEBOUNCE are passed to consult--async-throttle. TRANSFORM is an optional async function transforming the candidate. HIGHLIGHT is an optional highlight function, can be t for the default highlighting function.

Source Code

;; Defined in /nix/store/6higv2v1wk916v4ynnybyrdkfy2gq44d-emacs-packages-deps/share/emacs/site-lisp/elpa/consult-20261004.957/consult.el
;;;; Prebuilt async pipelines

(cl-defun consult--dynamic-collection (fun &key min-input throttle debounce
                                           transform highlight)
  "Dynamic candidate computation pipeline.
FUN computes the candidates.  It takes either a single input argument or
an input argument and a callback function, if computed candidates should
be updated incrementally.  The callback function must not be called
after FUN has returned.
MIN-INPUT is passed to `consult--async-min-input'.
THROTTLE and DEBOUNCE are passed to `consult--async-throttle'.
TRANSFORM is an optional async function transforming the candidate.
HIGHLIGHT is an optional highlight function, can be t for the default
highlighting function."
  (declare (indent 1))
  (consult--async-pipeline
   (consult--async-min-input min-input)
   (consult--async-throttle throttle debounce)
   (consult--async-dynamic fun)
   transform
   (and highlight (consult--async-highlight highlight))))