Function: eshell-accumulate-worker-create

eshell-accumulate-worker-create is a byte-compiled function defined in esh-worker.el.gz.

Signature

(eshell-accumulate-worker-create &key STATUS ESHELL-BUFFER OUTPUT-HANDLES ENSURE-NEWLINE-P FUNCTION BUFFER-OR-VALUE)

Documentation

Constructor for objects of type eshell-accumulate-worker.

Source Code

;; Defined in /usr/src/emacs/lisp/eshell/esh-worker.el.gz
;; Accumulate worker

(cl-defstruct (eshell-accumulate-worker
               (:include eshell-worker)
               (:constructor eshell-accumulate-worker-create))
  "A worker that calls a Lisp function once with all output.
When outputting data to this worker, it will accumulate all the text,
calling a Lisp FUNCTION once at the end.

When outputting non-string data types to this worker (e.g. lists), it
will first convert the data to a string before concatenating it.  If
this structure only receives a single non-string value as input, it will
pass the value unaltered to FUNCTION."
  (function nil :read-only t)
  (buffer-or-value nil))