The file-attributes Reference Manual

This is the file-attributes Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 05:13:50 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

The main system appears first, followed by any subsystem dependency.


2.1 file-attributes

Access to file attributes (uid, gid, atime, mtime, mod)

Maintainer

Yukari Hafner <>

Author

Yukari Hafner <>

Home Page

https://shinmera.github.io/file-attributes

Source Control

(GIT https://github.com/Shinmera/file-attributes.git)

Bug Tracker

https://github.com/Shinmera/file-attributes/issues

License

zlib

Version

1.0.0

Defsystem Dependency

trivial-features (system).

Dependencies
  • documentation-utils (system).
  • cffi (system).
Source

file-attributes.asd.

Child Components

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


3.1 Lisp


3.1.1 file-attributes/file-attributes.asd

Source

file-attributes.asd.

Parent Component

file-attributes (system).

ASDF Systems

file-attributes.


3.1.2 file-attributes/package.lisp

Source

file-attributes.asd.

Parent Component

file-attributes (system).

Packages

org.shirakumo.file-attributes.


3.1.3 file-attributes/protocol.lisp

Dependency

package.lisp (file).

Source

file-attributes.asd.

Parent Component

file-attributes (system).

Public Interface
Internals

3.1.4 file-attributes/posix.lisp

If Feature

:unix

Dependency

protocol.lisp (file).

Source

file-attributes.asd.

Parent Component

file-attributes (system).

Public Interface
Internals

3.1.5 file-attributes/linux.lisp

If Feature

:linux

Dependencies
Source

file-attributes.asd.

Parent Component

file-attributes (system).

Public Interface
Internals

3.1.6 file-attributes/windows.lisp

If Feature

:windows

Dependencies
Source

file-attributes.asd.

Parent Component

file-attributes (system).


3.1.7 file-attributes/mezzano.lisp

If Feature

:mezzano

Dependencies
Source

file-attributes.asd.

Parent Component

file-attributes (system).


3.1.8 file-attributes/documentation.lisp

Dependencies
Source

file-attributes.asd.

Parent Component

file-attributes (system).


4 Packages

Packages are listed by definition order.


4.1 org.shirakumo.file-attributes

Source

package.lisp.

Use List

common-lisp.

Public Interface
Internals

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


5.1 Public Interface


5.1.1 Special variables

Special Variable: *system*

The default system as recognised through feature flags.

Package

org.shirakumo.file-attributes.

Source

protocol.lisp.


5.1.2 Ordinary functions

Function: access-time (file)

Accesses the last time this file was accessed.

Signals an error if retrieving or setting the information is not possible.

Package

org.shirakumo.file-attributes.

Source

linux.lisp.

Function: (setf access-time) (file)
Package

org.shirakumo.file-attributes.

Source

posix.lisp.

Function: attributes (file)

Accesses the attributes of this file.

The attributes are expressed as a positive integer.

Signals an error if retrieving or setting the information is not possible.

The contents of the file attributes are highly system specific and may contain things such as user permissions or file kind information.

See ENCODE-ATTRIBUTES
See DECODE-ATTRIBUTES

Package

org.shirakumo.file-attributes.

Source

linux.lisp.

Function: (setf attributes) (file)
Package

org.shirakumo.file-attributes.

Source

posix.lisp.

Function: creation-time (file)

Accesses the time this file was created.

Signals an error if retrieving or setting the information is not possible.

Package

org.shirakumo.file-attributes.

Source

linux.lisp.

Function: (setf creation-time) (file)
Package

org.shirakumo.file-attributes.

Source

protocol.lisp.

Function: decode-attributes (attributes &optional system)

Decodes an integer for attributes of the requested system into a standardised plist of file attributes.

Which flags are be produced is highly dependent on the system, but the
following may appear:

:ARCHIVED
:COMPRESSED
:DEVICE
:DIRECTORY
:ENCRYPTED
:FIFO
:GROUP-EXECUTE
:GROUP-READ
:GROUP-WRITE
:HIDDEN
:INTEGRITY
:LINK
:NO-SCRUB
:NORMAL
:NOT-INDEXED
:OFFLINE
:OTHER-EXECUTE
:OTHER-READ
:OTHER-WRITE
:OWNER-EXECUTE
:OWNER-READ
:OWNER-WRITE
:READ-ONLY
:RECALL
:SET-GROUP
:SET-USER
:SOCKET
:SPARSE
:STICKY
:SYSTEM-FILE
:TEMPORARY
:VIRTUAL

See ENCODE-ATTRIBUTES
See *SYSTEM*

Package

org.shirakumo.file-attributes.

Source

protocol.lisp.

Function: encode-attributes (attributes &optional system)

Encodes a plist of file attributes into an integer suitable for the requested system.

See DECODE-ATTRIBUTES
See *SYSTEM*

Package

org.shirakumo.file-attributes.

Source

protocol.lisp.

Function: group (file)

Accesses the owning group of this file.

The group is expressed as a positive integer.

Signals an error if retrieving or setting the information is not possible.

Package

org.shirakumo.file-attributes.

Source

linux.lisp.

Function: (setf group) (file)
Package

org.shirakumo.file-attributes.

Source

posix.lisp.

Function: modification-time (file)

Accesses the last time this file was modified.

Signals an error if retrieving or setting the information is not possible.

Package

org.shirakumo.file-attributes.

Source

linux.lisp.

Function: (setf modification-time) (file)
Package

org.shirakumo.file-attributes.

Source

posix.lisp.

Function: owner (file)

Accesses the owning user of this file.

The user is expressed as a positive integer.

Signals an error if retrieving or setting the information is not possible.

Package

org.shirakumo.file-attributes.

Source

linux.lisp.

Function: (setf owner) (file)
Package

org.shirakumo.file-attributes.

Source

posix.lisp.


5.2 Internals


5.2.1 Constants

Constant: at-fdcwd
Package

org.shirakumo.file-attributes.

Source

linux.lisp.

Constant: statx-atime
Package

org.shirakumo.file-attributes.

Source

linux.lisp.

Constant: statx-btime
Package

org.shirakumo.file-attributes.

Source

linux.lisp.

Constant: statx-gid
Package

org.shirakumo.file-attributes.

Source

linux.lisp.

Constant: statx-mode
Package

org.shirakumo.file-attributes.

Source

linux.lisp.

Constant: statx-mtime
Package

org.shirakumo.file-attributes.

Source

linux.lisp.

Constant: statx-uid
Package

org.shirakumo.file-attributes.

Source

linux.lisp.


5.2.2 Special variables

Special Variable: *unix-attributes*
Package

org.shirakumo.file-attributes.

Source

protocol.lisp.

Special Variable: *windows-attributes*
Package

org.shirakumo.file-attributes.

Source

protocol.lisp.


5.2.3 Macros

Macro: define-implementable (name args)
Package

org.shirakumo.file-attributes.

Source

protocol.lisp.

Macro: define-implementation (name args &body body)
Package

org.shirakumo.file-attributes.

Source

protocol.lisp.


5.2.4 Ordinary functions

Function: cchmod (path mode)
Package

org.shirakumo.file-attributes.

Source

posix.lisp.

Function: cchown (path owner group)
Package

org.shirakumo.file-attributes.

Source

posix.lisp.

Function: cgstat (path buffer)
Package

org.shirakumo.file-attributes.

Source

posix.lisp.

Function: chmod (path mode)
Package

org.shirakumo.file-attributes.

Source

posix.lisp.

Function: chown (path uid gid)
Package

org.shirakumo.file-attributes.

Source

posix.lisp.

Function: cstat (path buffer)
Package

org.shirakumo.file-attributes.

Source

posix.lisp.

Function: cstatx (dirfd path flags mask statx)
Package

org.shirakumo.file-attributes.

Source

linux.lisp.

Function: cutimes (path times)
Package

org.shirakumo.file-attributes.

Source

posix.lisp.

Function: cxstat (path buffer)
Package

org.shirakumo.file-attributes.

Source

posix.lisp.

Function: debitfield (int &rest bits)
Package

org.shirakumo.file-attributes.

Source

protocol.lisp.

Function: decode-bitfield (int bits)
Package

org.shirakumo.file-attributes.

Source

protocol.lisp.

Function: enbitfield (list &rest bits)
Package

org.shirakumo.file-attributes.

Source

protocol.lisp.

Function: encode-bitfield (field bits)
Package

org.shirakumo.file-attributes.

Source

protocol.lisp.

Function: enpath (path)
Package

org.shirakumo.file-attributes.

Source

protocol.lisp.

Function: stat (path)
Package

org.shirakumo.file-attributes.

Source

posix.lisp.

Function: statx (path mask)
Package

org.shirakumo.file-attributes.

Source

linux.lisp.

Function: universal->unix (universal)
Package

org.shirakumo.file-attributes.

Source

posix.lisp.

Function: unix->universal (unix)
Package

org.shirakumo.file-attributes.

Source

posix.lisp.

Function: utimes (path atime mtime)
Package

org.shirakumo.file-attributes.

Source

posix.lisp.


5.2.5 Classes

Class: stat-tclass
Package

org.shirakumo.file-attributes.

Source

posix.lisp.

Direct superclasses
  • foreign-struct-type.
  • translatable-foreign-type.
Class: statx-tclass
Package

org.shirakumo.file-attributes.

Source

linux.lisp.

Direct superclasses
  • foreign-struct-type.
  • translatable-foreign-type.
Class: statx-timestamp-tclass
Package

org.shirakumo.file-attributes.

Source

linux.lisp.

Direct superclasses
  • foreign-struct-type.
  • translatable-foreign-type.

Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
A   C   D   E   F   G   M   O   S   U  
Index Entry  Section

(
(setf access-time): Public ordinary functions
(setf attributes): Public ordinary functions
(setf creation-time): Public ordinary functions
(setf group): Public ordinary functions
(setf modification-time): Public ordinary functions
(setf owner): Public ordinary functions

A
access-time: Public ordinary functions
attributes: Public ordinary functions

C
cchmod: Private ordinary functions
cchown: Private ordinary functions
cgstat: Private ordinary functions
chmod: Private ordinary functions
chown: Private ordinary functions
creation-time: Public ordinary functions
cstat: Private ordinary functions
cstatx: Private ordinary functions
cutimes: Private ordinary functions
cxstat: Private ordinary functions

D
debitfield: Private ordinary functions
decode-attributes: Public ordinary functions
decode-bitfield: Private ordinary functions
define-implementable: Private macros
define-implementation: Private macros

E
enbitfield: Private ordinary functions
encode-attributes: Public ordinary functions
encode-bitfield: Private ordinary functions
enpath: Private ordinary functions

F
Function, (setf access-time): Public ordinary functions
Function, (setf attributes): Public ordinary functions
Function, (setf creation-time): Public ordinary functions
Function, (setf group): Public ordinary functions
Function, (setf modification-time): Public ordinary functions
Function, (setf owner): Public ordinary functions
Function, access-time: Public ordinary functions
Function, attributes: Public ordinary functions
Function, cchmod: Private ordinary functions
Function, cchown: Private ordinary functions
Function, cgstat: Private ordinary functions
Function, chmod: Private ordinary functions
Function, chown: Private ordinary functions
Function, creation-time: Public ordinary functions
Function, cstat: Private ordinary functions
Function, cstatx: Private ordinary functions
Function, cutimes: Private ordinary functions
Function, cxstat: Private ordinary functions
Function, debitfield: Private ordinary functions
Function, decode-attributes: Public ordinary functions
Function, decode-bitfield: Private ordinary functions
Function, enbitfield: Private ordinary functions
Function, encode-attributes: Public ordinary functions
Function, encode-bitfield: Private ordinary functions
Function, enpath: Private ordinary functions
Function, group: Public ordinary functions
Function, modification-time: Public ordinary functions
Function, owner: Public ordinary functions
Function, stat: Private ordinary functions
Function, statx: Private ordinary functions
Function, universal->unix: Private ordinary functions
Function, unix->universal: Private ordinary functions
Function, utimes: Private ordinary functions

G
group: Public ordinary functions

M
Macro, define-implementable: Private macros
Macro, define-implementation: Private macros
modification-time: Public ordinary functions

O
owner: Public ordinary functions

S
stat: Private ordinary functions
statx: Private ordinary functions

U
universal->unix: Private ordinary functions
unix->universal: Private ordinary functions
utimes: Private ordinary functions


A.4 Data types

Jump to:   C   D   F   L   M   O   P   S   W  
Index Entry  Section

C
Class, stat-tclass: Private classes
Class, statx-tclass: Private classes
Class, statx-timestamp-tclass: Private classes

D
documentation.lisp: The file-attributes/documentation․lisp file

F
File, documentation.lisp: The file-attributes/documentation․lisp file
File, file-attributes.asd: The file-attributes/file-attributes․asd file
File, linux.lisp: The file-attributes/linux․lisp file
File, mezzano.lisp: The file-attributes/mezzano․lisp file
File, package.lisp: The file-attributes/package․lisp file
File, posix.lisp: The file-attributes/posix․lisp file
File, protocol.lisp: The file-attributes/protocol․lisp file
File, windows.lisp: The file-attributes/windows․lisp file
file-attributes: The file-attributes system
file-attributes.asd: The file-attributes/file-attributes․asd file

L
linux.lisp: The file-attributes/linux․lisp file

M
mezzano.lisp: The file-attributes/mezzano․lisp file

O
org.shirakumo.file-attributes: The org․shirakumo․file-attributes package

P
Package, org.shirakumo.file-attributes: The org․shirakumo․file-attributes package
package.lisp: The file-attributes/package․lisp file
posix.lisp: The file-attributes/posix․lisp file
protocol.lisp: The file-attributes/protocol․lisp file

S
stat-tclass: Private classes
statx-tclass: Private classes
statx-timestamp-tclass: Private classes
System, file-attributes: The file-attributes system

W
windows.lisp: The file-attributes/windows․lisp file