This is the cl-tqdm Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 15:48:05 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
cl-tqdmSimple And Fast Progress Bar Library for Common Lisp
hikettei
(GIT git@github.com:hikettei/cl-tqdm.git)
MIT
cl-tqdm.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
cl-tqdm/cl-tqdm.lispcl-tqdm (system).
config (function).
print-object (method).
print-object (method).
tqdm (function).
update (function).
with-config (macro).
with-no-animation (macro).
with-tqdm (macro).
*in-update-method* (special variable).
*tqdm-config* (special variable).
backward-lines (function).
config-animation (reader).
(setf config-animation) (writer).
config-bar-string (reader).
(setf config-bar-string) (writer).
config-indent (reader).
(setf config-indent) (writer).
config-space-string (reader).
(setf config-space-string) (writer).
copy-tqdmbar (function).
copy-tqdmconfig (function).
progress-percent (function).
render (function).
render-progress-bar (function).
tqdm-call-timestamps (reader).
(setf tqdm-call-timestamps) (writer).
tqdm-count-idx (reader).
(setf tqdm-count-idx) (writer).
tqdm-creation-time (reader).
(setf tqdm-creation-time) (writer).
tqdm-description (reader).
(setf tqdm-description) (writer).
tqdm-identifier (reader).
(setf tqdm-identifier) (writer).
tqdm-total-count (reader).
(setf tqdm-total-count) (writer).
tqdmbar (structure).
tqdmbar-p (function).
tqdmconfig (structure).
tqdmconfig-p (function).
Packages are listed by definition order.
cl-tqdmcommon-lisp.
config (function).
tqdm (function).
update (function).
with-config (macro).
with-no-animation (macro).
with-tqdm (macro).
*in-update-method* (special variable).
*tqdm-config* (special variable).
backward-lines (function).
config-animation (reader).
(setf config-animation) (writer).
config-bar-string (reader).
(setf config-bar-string) (writer).
config-indent (reader).
(setf config-indent) (writer).
config-space-string (reader).
(setf config-space-string) (writer).
copy-tqdmbar (function).
copy-tqdmconfig (function).
progress-percent (function).
render (function).
render-progress-bar (function).
tqdm-call-timestamps (reader).
(setf tqdm-call-timestamps) (writer).
tqdm-count-idx (reader).
(setf tqdm-count-idx) (writer).
tqdm-creation-time (reader).
(setf tqdm-creation-time) (writer).
tqdm-description (reader).
(setf tqdm-description) (writer).
tqdm-identifier (reader).
(setf tqdm-identifier) (writer).
tqdm-total-count (reader).
(setf tqdm-total-count) (writer).
tqdmbar (structure).
tqdmbar-p (function).
tqdmconfig (structure).
tqdmconfig-p (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Example:
(with-config (config :animation nil)
(with-tqdm
~~~))
Example:
(with-tqdm x :ProgressBar1 100 ""
(update x))
tqdmconfig) stream) ¶Rendering given status (which is the structure of tqdmbar), render returns the output string.
Tqdm Structure that contains informations.
APIs read this structure and update, rendering progress-bar in terminals.
Example:
“‘lisp
(print (tqdm :FirstBar 100))
“‘
structure-object.
symbol
:no-name
fixnum
0
fixnum
0
list
(integer 0 4611686018427387903)
0
string
""
structure-object.
boolean
t
string
" "
string
"█"
fixnum
0
| Jump to: | (
B C F M P R T U W |
|---|
| Jump to: | (
B C F M P R T U W |
|---|
| Jump to: | *
A B C D I S T |
|---|
| Jump to: | *
A B C D I S T |
|---|
| Jump to: | C F P S T |
|---|
| Jump to: | C F P S T |
|---|