Function: progress-reporter-update

progress-reporter-update is a byte-compiled function defined in subr.el.gz.

Signature

(progress-reporter-update REPORTER &optional VALUE UPDATE-TEXT)

Documentation

Report progress of an operation, by default, in the echo area.

REPORTER should be the result of a call to make-progress-reporter.

If REPORTER is a numerical progress reporter---i.e. if it was made using non-nil MIN-VALUE and MAX-VALUE arguments to make-progress-reporter---then VALUE should be a number between MIN-VALUE and MAX-VALUE.

Optional argument UPDATE-TEXT is a string that a progress-reporter back-end might display as a result of this update. A typical use is as the "step" of the progress reporting process. If REPORTER is a non-numerical reporter, then VALUE should be nil, or a string to use instead of UPDATE-TEXT.

See progress-reporter-update-functions for the list of functions called on each update.

This function is relatively inexpensive. If the change since last update is too small or insufficient time has passed, it does nothing.

View in manual

Probably introduced at or before Emacs version 22.1.

Aliases

eglot--reporter-update

Source Code

;; Defined in /usr/src/emacs/lisp/subr.el.gz
(defsubst progress-reporter-update (reporter &optional value update-text)
  "Report progress of an operation, by default, in the echo area.
REPORTER should be the result of a call to `make-progress-reporter'.

If REPORTER is a numerical progress reporter---i.e. if it was
made using non-nil MIN-VALUE and MAX-VALUE arguments to
`make-progress-reporter'---then VALUE should be a number between
MIN-VALUE and MAX-VALUE.

Optional argument UPDATE-TEXT is a string that a progress-reporter
back-end might display as a result of this update.  A typical use is as
the \"step\" of the progress reporting process.  If REPORTER is a
non-numerical reporter, then VALUE should be nil, or a string to use
instead of UPDATE-TEXT.

See `progress-reporter-update-functions' for the list of functions
called on each update.

This function is relatively inexpensive.  If the change since
last update is too small or insufficient time has passed, it does
nothing."
  (when (or (not (numberp value))      ; For pulsing reporter
	    (>= value (car reporter))) ; For numerical reporter
    (progress-reporter-do-update reporter value update-text)))