00001 # Stats {#api_stats}
00002
00003 Encoding and decoding routines accumulate compression performance
00004 statistics, such as the number of bytes read and written, indicators
00005 a ::rs_stats_t structure.
00006
00007 The particular statistics collected depend on the type
00008 of job.
00009
00010 Stats may be
00011 converted to human-readable form or written to the log file using
00012 ::rs_format_stats() or ::rs_log_stats() respectively.
00013
00014 Statistics are held in a structure referenced by the job object. The
00015 statistics are kept up-to-date as the job runs and so can be used for
00016 progress indicators.
00017
00018 ::rs_job_statistics returns a pointer to statistics for the job. The
00019 pointer is valid throughout the life of the job, until the job is freed.
00020 The statistics are updated during processing and can be used to measure
00021 progress.
00022
00023 Whole-file functions write statistics into a structure supplied by the caller.
00024 \c NULL may be passed as the \p stats pointer if you don't want the stats.