Function

Summary

Provides read access to the C stat structure which describes files.

Note: not applicable on Microsoft Windows.

Package

system

Signature

get-file-stat filename-or-fd => file-stat (,errno)

Arguments

filename-or-fd

A string denoting a file, or a file descriptor.

Values

file-stat

On success, an object representing the stat values. On failure, nil is returned together with a second value.

errno

Indicates the errno value returned by the system call. This second value is returned only in the case of failure.

Description

file-stat is an object representing the stat values, as would be returned by the system call stat (for a filename) or the system call fstat (for an fd).

The values in file-stat are the raw data, and it is the responsibility of the user to interpret them when needed. See the UNIX manual entry for stat for details.

The values can be read from file-stat by these readers:

sys:file-stat-inode
The inode of the file.

sys:file-stat-device
The id of the device where the file is.

sys:file-stat-owner-id
The user id of the owner of the file.

sys:file-stat-group-id
The group id of the file's group.

sys:file-stat-size
The size of the file in bytes.

sys:file-stat-blocks
The number of 512-bytes blocks used by the file.

sys:file-stat-mode
The protection value of the file.

sys:file-stat-last-access

sys:file-stat-last-change

sys:file-stat-last-modify
The times of the last access to the file, last change in the data of the file and the last modification of the file status, in seconds from 1 January 1970.

sys:file-stat-links
The number of hard links to the file.

sys:file-stat-device-type
The device type (sometimes called Rdev).