Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the trivial-file-size Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Dec 02 11:32:51 2019 GMT+0.
| • Introduction | What trivial-file-size is all about | |
| • Systems | The systems documentation | |
| • Files | The files documentation | |
| • Packages | The packages documentation | |
| • Definitions | The symbols documentation | |
| • Indexes | Concepts, functions, variables and data types |
This library exports a single function, file-size-in-octets. It
returns the size of a file in bytes, using system calls when possible.
The canonical way to determine the size of a file in bytes, using
Common Lisp, is to open the file with an element type of
(unsigned-byte 8) and then calculate the length of the stream. This
is less than ideal. In most cases it would be better to get the size
of the file from its metadata, using a system call.
This is a problem I have run into several times in several different projects. I want it solved, once and for all.
At the moment, getting the file size from metadata is supported for the following Lisps:
For other Lisps and platforms, we fall back to opening the file and
calling file-length on the stream.
This library is as much a call to arms as it is a resource. If you know how to stat a file on your Common Lisp implementation, on your platform, please make a pull request -- or just open an issue to point me to the right documentation, and I'll do all the work.
Next: Files, Previous: Introduction, Up: Top [Contents][Index]
The main system appears first, followed by any subsystem dependency.
| • The trivial-file-size system |
Paul M. Rodriguez <pmr@ruricolist.com>
MIT
Stat a file’s size.
trivial-file-size.asd (file)
Files are sorted by type and then listed depth-first from the systems components trees.
| • Lisp files |
| • The trivial-file-size.asd file | ||
| • The trivial-file-size/package.lisp file | ||
| • The trivial-file-size/trivial-file-size.lisp file |
Next: The trivial-file-size/package․lisp file, Previous: Lisp files, Up: Lisp files [Contents][Index]
trivial-file-size.asd
trivial-file-size (system)
Next: The trivial-file-size/trivial-file-size․lisp file, Previous: The trivial-file-size․asd file, Up: Lisp files [Contents][Index]
trivial-file-size (system)
package.lisp
Previous: The trivial-file-size/package․lisp file, Up: Lisp files [Contents][Index]
package.lisp (file)
trivial-file-size (system)
trivial-file-size.lisp
file-size-in-octets (function)
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
| • The trivial-file-size package |
package.lisp (file)
common-lisp
file-size-in-octets (function)
Definitions are sorted by export status, category, package, and then by lexicographic order.
| • Exported definitions | ||
| • Internal definitions |
Next: Internal definitions, Previous: Definitions, Up: Definitions [Contents][Index]
| • Exported functions |
Previous: Exported definitions, Up: Exported definitions [Contents][Index]
Return the size of FILE in octets.
Whenever possible, get the size from the file’s metadata.
Some platforms (e.g. ABCL) may return 0 when the file does not exist.
trivial-file-size.lisp (file)
Previous: Exported definitions, Up: Definitions [Contents][Index]
| • Internal functions | ||
| • Internal types |
Next: Internal types, Previous: Internal definitions, Up: Internal definitions [Contents][Index]
trivial-file-size.lisp (file)
Previous: Internal functions, Up: Internal definitions [Contents][Index]
trivial-file-size.lisp (file)
Previous: Definitions, Up: Top [Contents][Index]
| • Concept index | ||
| • Function index | ||
| • Variable index | ||
| • Data type index |
Next: Function index, Previous: Indexes, Up: Indexes [Contents][Index]
| Jump to: | F L T |
|---|
| Jump to: | F L T |
|---|
Next: Variable index, Previous: Concept index, Up: Indexes [Contents][Index]
| Jump to: | F |
|---|
| Jump to: | F |
|---|
Next: Data type index, Previous: Function index, Up: Indexes [Contents][Index]
Previous: Variable index, Up: Indexes [Contents][Index]
| Jump to: | F P S T |
|---|
| Jump to: | F P S T |
|---|