Skip to main content

Module format

Module format 

Source
Expand description

Index file format constants and header parsing.

All integers little-endian. All offsets absolute from file start. Sections aligned to 8-byte boundaries.

Modules§

flags
Bit-flag constants stored in the Header::flags field.

Structs§

Beacon
A heartbeat file written by the ixd daemon so other processes can detect a running watcher and query its status.
Header
Parsed contents of the fixed 256-byte index header.

Enums§

FileStatus
Whether a file tracked by the index is current, out-of-date, or deleted.

Constants§

FILE_ENTRY_SIZE
On-disk size of one file-table entry in the index.
HEADER_SIZE
Size of the fixed header at the start of every index file (256 bytes).
MAGIC
Magic bytes identifying an ix index file (b"IX01").
TRIGRAM_ENTRY_SIZE
On-disk size of one trigram-table entry (u32 key + 16-byte payload).
VERSION_MAJOR
Major version of the on-disk format this library writes.
VERSION_MINOR
Minimum minor version required to read an index file.

Functions§

is_binary
Centralized binary file detection.