@tauri-apps/plugin-fs - v2.4.1
    Preparing search index...

    Interface FileInfo

    A FileInfo describes a file and is returned by stat, lstat or fstat.

    2.0.0

    interface FileInfo {
        isFile: boolean;
        isDirectory: boolean;
        isSymlink: boolean;
        size: number;
        mtime: null | Date;
        atime: null | Date;
        birthtime: null | Date;
        readonly: boolean;
        fileAttributes: null | number;
        dev: null | number;
        ino: null | number;
        mode: null | number;
        nlink: null | number;
        uid: null | number;
        gid: null | number;
        rdev: null | number;
        blksize: null | number;
        blocks: null | number;
    }
    Index

    Properties

    isFile isDirectory isSymlink size mtime atime birthtime readonly fileAttributes dev ino mode nlink uid gid rdev blksize blocks

    Properties

    isFile: boolean

    True if this is info for a regular file. Mutually exclusive to FileInfo.isDirectory and FileInfo.isSymlink.

    isDirectory: boolean

    True if this is info for a regular directory. Mutually exclusive to FileInfo.isFile and FileInfo.isSymlink.

    isSymlink: boolean

    True if this is info for a symlink. Mutually exclusive to FileInfo.isFile and FileInfo.isDirectory.

    size: number

    The size of the file, in bytes.

    mtime: null | Date

    The last modification time of the file. This corresponds to the mtime field from stat on Linux/Mac OS and ftLastWriteTime on Windows. This may not be available on all platforms.

    atime: null | Date

    The last access time of the file. This corresponds to the atime field from stat on Unix and ftLastAccessTime on Windows. This may not be available on all platforms.

    birthtime: null | Date

    The creation time of the file. This corresponds to the birthtime field from stat on Mac/BSD and ftCreationTime on Windows. This may not be available on all platforms.

    readonly: boolean

    Whether this is a readonly (unwritable) file.

    fileAttributes: null | number

    This field contains the file system attribute information for a file or directory. For possible values and their descriptions, see File Attribute Constants in the Windows Dev Center

    • macOS / Linux / Android / iOS: Unsupported.
    dev: null | number

    ID of the device containing the file.

    • Windows: Unsupported.
    ino: null | number

    Inode number.

    • Windows: Unsupported.
    mode: null | number

    The underlying raw st_mode bits that contain the standard Unix permissions for this file/directory.

    • Windows: Unsupported.
    nlink: null | number

    Number of hard links pointing to this file.

    • Windows: Unsupported.
    uid: null | number

    User ID of the owner of this file.

    • Windows: Unsupported.
    gid: null | number

    Group ID of the owner of this file.

    • Windows: Unsupported.
    rdev: null | number

    Device ID of this file.

    • Windows: Unsupported.
    blksize: null | number

    Blocksize for filesystem I/O.

    • Windows: Unsupported.
    blocks: null | number

    Number of blocks allocated to the file, in 512-byte units.

    • Windows: Unsupported.

    Settings

    Member Visibility

    On This Page

    Properties