filesystem_models

LucidLink Python Library - Filesystem Type Definitions

Types for filesystem entries, sizes, and statistics.

dataclass

lucidlink.filesystem_models.DirEntry

Represents a file or directory entry in the filesystem.

Returned by Filesystem.read_dir() and Filesystem.get_entry().

Attribute	Type	Description
`name`	`str`	Name of the file/directory (without path).
`size`	`int`	Size in bytes (0 for directories).
`type`	`str`	Entry type string ("file", "dir", "link", "unknown").
`file_id`	`str`	Unique file identifier.
`file_id_external`	`int`	External file identifier.
`ctime`	`int`	Creation time (Unix timestamp).
`mtime`	`int`	Last modification time (Unix timestamp).

name

Type: str
Description: Name of the file/directory (without path).

size

Type: int
Description: Size in bytes (0 for directories).

type

Type: str
Description: Entry type string ("file", "dir", "link", "unknown").

file_id

Type: str
Description: Unique file identifier.

file_id_external

Type: int
Description: External file identifier.

ctime

Type: int
Description: Creation time (Unix timestamp).

mtime

Type: int
Description: Last modification time (Unix timestamp).

method

is_dir() -> `bool`

Check if this entry is a directory.

method

is_file() -> `bool`

Check if this entry is a regular file.

method

is_link() -> `bool`

Check if this entry is a symbolic link.

dataclass

lucidlink.filesystem_models.FilespaceSize

Filespace size information.

Returned by Filesystem.get_size().

Attribute	Type	Description
`entries`	`int`	Size of metadata entries in bytes.
`data`	`int`	Size of file data in bytes.
`storage`	`int`	Total storage used in bytes.
`external_files_size`	`int`	Size of external (Connect) files in bytes.
`external_files_count`	`int`	Number of external (Connect) files.

entries

Type: int
Description: Size of metadata entries in bytes.

data

Type: int
Description: Size of file data in bytes.

storage

Type: int
Description: Total storage used in bytes.

external_files_size

Type: int
Description: Size of external (Connect) files in bytes.

external_files_count

Type: int
Description: Number of external (Connect) files.

dataclass

lucidlink.filesystem_models.FilespaceStatistics

Filespace statistics.

Returned by Filesystem.get_statistics().

Attribute	Type	Description
`file_count`	`int`	Number of files in the filespace.
`directory_count`	`int`	Number of directories in the filespace.
`symlink_count`	`int`	Number of symbolic links in the filespace.
`entries_size`	`int`	Size of metadata entries in bytes.
`data_size`	`int`	Size of file data in bytes.
`storage_size`	`int`	Total storage used in bytes.
`external_files_size`	`int`	Size of external (Connect) files in bytes.
`external_files_count`	`int`	Number of external (Connect) files.

file_count

Type: int
Description: Number of files in the filespace.

directory_count

Type: int
Description: Number of directories in the filespace.

symlink_count

Type: int
Description: Number of symbolic links in the filespace.

entries_size

Type: int
Description: Size of metadata entries in bytes.

data_size

Type: int
Description: Size of file data in bytes.

storage_size

Type: int
Description: Total storage used in bytes.

external_files_size

Type: int
Description: Size of external (Connect) files in bytes.

external_files_count

Type: int
Description: Number of external (Connect) files.

filesystem_models

lucidlink.filesystem_models.DirEntry

is_dir() -> bool

is_file() -> bool

is_link() -> bool

lucidlink.filesystem_models.FilespaceSize

lucidlink.filesystem_models.FilespaceStatistics

is_dir() -> `bool`

is_file() -> `bool`

is_link() -> `bool`