am-partitions 0.3.2

Pure-Rust partition-table probe (GPT/MBR) and filesystem-magic sniffer.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106

/*
 * am-partitions C ABI — GPT/MBR partition probe and FS-magic sniffer
 * over any FsCoreDevice handle.
 *
 * Workflow:
 *   1. Get an FsCoreDevice* from any sister crate (qcow2_open,
 *      fs_core_file_open, ...).
 *   2. partitions_probe(dev, &list)  -> opaque PartitionList*
 *   3. partitions_count(list), partitions_get(list, i, &info) -> enumerate
 *   4. partitions_sniff(list, i)     -> identify FS at partition start
 *   5. partitions_open_slice(list, i)-> child FsCoreDevice* over one
 *                                       partition (feed to a fs driver)
 *   6. fs_core_device_close(slice), partitions_list_free(list),
 *      fs_core_device_close(dev)
 *
 * Link with libam_partitions.a and include this header alongside fs_core.h.
 *
 * MIT license. (c) 2026 Antimatter Studios.
 */

#ifndef AM_PARTITIONS_H
#define AM_PARTITIONS_H

#include "fs_core.h"

#ifdef __cplusplus
extern "C" {
#endif

/* -------------------------------------------------------------------------
 * Filesystem-kind codes returned by partitions_sniff and stored in
 * PartitionInfo.fs_kind. Stable: do not renumber.
 * ------------------------------------------------------------------------- */

typedef enum {
    PART_FS_UNKNOWN     = 0,
    PART_FS_EXT2        = 1,
    PART_FS_EXT3        = 2,
    PART_FS_EXT4        = 3,
    PART_FS_NTFS        = 4,
    PART_FS_EXFAT       = 5,
    PART_FS_FAT32       = 6,
    PART_FS_FAT16       = 7,
    PART_FS_HFS_PLUS    = 8,
    PART_FS_APFS        = 9,
    PART_FS_LINUX_SWAP  = 10,
    PART_FS_ISO9660     = 11,
    PART_FS_SQUASHFS    = 12,
} PartitionsFsKind;

typedef enum {
    PART_TABLE_NONE = 0,
    PART_TABLE_GPT  = 1,
    PART_TABLE_MBR  = 2,
} PartitionsTableKind;

/* -------------------------------------------------------------------------
 * PartitionInfo — POD struct copied out by partitions_get. The `label`
 * pointer (when non-NULL) and `type_guid` are owned by the parent
 * PartitionList; copy them out before `partitions_list_free`.
 * ------------------------------------------------------------------------- */

typedef struct {
    uint64_t       start;           /* byte offset on the parent device */
    uint64_t       length;          /* bytes */
    int32_t        fs_kind;         /* one of PartitionsFsKind */
    int32_t        table_kind;      /* one of PartitionsTableKind */
    uint8_t        type_guid[16];   /* GPT type GUID, or zeros for MBR */
    uint8_t        type_byte;       /* MBR type byte, or 0 for GPT */
    uint8_t        _pad[7];         /* alignment */
    const char    *label;           /* NUL-terminated UTF-8, or NULL */
    size_t         label_len;       /* bytes excluding the NUL */
} PartitionInfo;

/* -------------------------------------------------------------------------
 * Opaque PartitionList. Allocated by partitions_probe, freed via
 * partitions_list_free.
 * ------------------------------------------------------------------------- */

typedef struct PartitionList PartitionList;

/* -------------------------------------------------------------------------
 * Entry points.
 * ------------------------------------------------------------------------- */

FsCoreErrorCode  partitions_probe(const FsCoreDevice *device,
                                   PartitionList **list_out);
size_t           partitions_count(const PartitionList *list);
int32_t          partitions_table_kind(const PartitionList *list);
FsCoreErrorCode  partitions_get(const PartitionList *list,
                                 size_t index,
                                 PartitionInfo *out);
/* Returns one of PartitionsFsKind, or -1 on error (last-error has detail). */
int32_t          partitions_sniff(const PartitionList *list, size_t index);
/* Sniff the whole device (no partition table). Returns one of PartitionsFsKind, or -1 on error. */
int32_t          partitions_sniff_device(const FsCoreDevice *device,
                                          uint64_t device_size_bytes);
/* Returns NULL on error (last-error has detail). */
FsCoreDevice   *partitions_open_slice(const PartitionList *list, size_t index);
void             partitions_list_free(PartitionList *list);

#ifdef __cplusplus
} /* extern "C" */
#endif

#endif /* AM_PARTITIONS_H */