matevfs Constants

matevfs Constants — the built-in constants of the matevfs module

Synopsis

      matevfs Directory Visit Options
      matevfs File Flags
      matevfs FileInfo Fields
      matevfs File Permissions
      matevfs FileInfo Options
      matevfs FileInfo Set Mask
      matevfs Open Mode Constants
      matevfs Seek Constants
      matevfs Monitor Type Constants
    

Description

matevfs Directory Visit Options

These options control the way in which directories are visited.

matevfs.DIRECTORY_VISIT_DEFAULT

The default directory visit mode.

matevfs.DIRECTORY_VISIT_SAMEFS

Visit only directories on the same file system as the parent.

matevfs.DIRECTORY_VISIT_LOOPCHECK

Prevent a loop if it would be caused (e.g. by following a symbolic link).

matevfs File Flags

Special flags that a matevfs.FileInfo object can have.

matevfs.FILE_FLAGS_NONE

No flags.

matevfs.FILE_FLAGS_SYMLINK

Whether the file is a symbolic link.

matevfs.FILE_FLAGS_LOCAL

Whether the file is on a local filesystem.

matevfs FileInfo Fields

Flags indicating what fields in a matevfs.FileInfo object are valid.

matevfs.FILE_INFO_FIELDS_NONE

matevfs.FILE_INFO_FIELDS_TYPE

matevfs.FILE_INFO_FIELDS_PERMISSIONS

matevfs.FILE_INFO_FIELDS_FLAGS

matevfs.FILE_INFO_FIELDS_DEVICE

matevfs.FILE_INFO_FIELDS_INODE

matevfs.FILE_INFO_FIELDS_LINK_COUNT

matevfs.FILE_INFO_FIELDS_SIZE

matevfs.FILE_INFO_FIELDS_BLOCK_COUNT

matevfs.FILE_INFO_FIELDS_IO_BLOCK_SIZE

matevfs.FILE_INFO_FIELDS_ATIME

matevfs.FILE_INFO_FIELDS_MTIME

matevfs.FILE_INFO_FIELDS_CTIME

matevfs.FILE_INFO_FIELDS_SYMLINK_NAME

matevfs.FILE_INFO_FIELDS_MIME_TYPE

matevfs File Permissions

File permissions. These are essentially the same as the unix permissions field.

matevfs.PERM_SUID

Set UID on access.

matevfs.PERM_SGID

Set GID on access.

matevfs.PERM_STICKY

Sticky.

matevfs.PERM_USER_READ

Owner has read permission.

matevfs.PERM_USER_WRITE

Owner has write permission.

matevfs.PERM_USER_EXEC

Owner has execution permission.

matevfs.PERM_USER_ALL

Owner has all permissions.

matevfs.PERM_GROUP_READ

Group has read permission.

matevfs.PERM_GROUP_WRITE

Group has write permission.

matevfs.PERM_GROUP_EXEC

Group has execution permission.

matevfs.PERM_GROUP_ALL

Group has all permissions.

matevfs.PERM_OTHER_READ

Others have read permission.

matevfs.PERM_OTHER_WRITE

Others have write permission.

matevfs.PERM_OTHER_EXEC

Others have execution permission.

matevfs.PERM_OTHER_ALL

Others have all permissions.

matevfs FileInfo Options

These options affect the way file information is retrieved.

matevfs.FILE_INFO_DEFAULT

matevfs.FILE_INFO_GET_MIME_TYPE

Detect the MIME type.

matevfs.FILE_INFO_FORCE_FAST_MIME_TYPE

Only use fast MIME type detection (file extensions).

matevfs.FILE_INFO_FORCE_SLOW_MIME_TYPE

Force slow MIME type detection where available (sniffing, algorithmic detection, etc).

matevfs.FILE_INFO_FOLLOW_LINKS

Automatically follow symbolic links and retrieve the properties of their target (recommended).

matevfs FileInfo Set Mask

These options affect which file aspects are changed in the set_file_info method.

matevfs.SET_FILE_INFO_NONE

Don't set any file info fields.

matevfs.SET_FILE_INFO_NAME

Change the name.

matevfs.SET_FILE_INFO_PERMISSIONS

Change the permissions.

matevfs.SET_FILE_INFO_OWNER

Change the file's owner.

matevfs.SET_FILE_INFO_TIME

Change the file's time stamp(s).

matevfs Open Mode Constants

These options affect how files are opened.

matevfs.OPEN_NONE

matevfs.OPEN_READ

Open the file for reading.

matevfs.OPEN_WRITE

Open the file for writing.

matevfs.OPEN_RANDOM

Allow random access on the file.

matevfs.OPEN_TRUNCATE

Truncate the file.

matevfs Seek Constants

These constants are used to specify the start position for seek operations.

matevfs.SEEK_START

The start of the file.

matevfs.SEEK_CURRENT

The current position in the file.

matevfs.SEEK_END

The end of the file.

matevfs Monitor Type Constants

The type of resources that can be monitored.

matevfs.MONITOR_FILE

Monitor a file.

matevfs.MONITOR_DIRECTORY

Monitor a directory.

matevfs Monitor Events

Types of events that can be recieved from a monitor.

matevfs.MONITOR_EVENT_CHANGED

File data was changed.

matevfs.MONITOR_EVENT_DELETED

File was deleted.

matevfs.MONITOR_EVENT_STARTEXECUTING

matevfs.MONITOR_EVENT_STOPEXECUTING

matevfs.MONITOR_EVENT_CREATED

File was created.

matevfs.MONITOR_EVENT_METADATA_CHANGED

File's metadata was changed.