package
1.0.18
Repository: https://github.com/blacktop/go-apfs.git
Documentation: pkg.go.dev

# Functions

No description provided by the author
GetDecmpfsHeader parses the decmpfs header from an xattr node entry.
NewFSTree returns a new FSTree.
ReadObj returns a verified object or error if block does not verify.
No description provided by the author

# Constants

No description provided by the author
* Optional Volume Feature Flags **/.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* Volume Flags **/.
No description provided by the author
* Partition UUIDs **/.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* Incompatible Volume Feature Flags **/.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* Volume Reaper States **/.
* Integrity Metadata Flags **/.
No description provided by the author
No description provided by the author
* Read-Only Comaptible Volume Feature Flags **/.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
~0ULL.
No description provided by the author
APFS_VOL_KEYBAG_ENTRY_MAX_SIZE
No description provided by the author
= 0x0180.
= 0x0080 --- formerly defined explicitly as `0x0080`.
= 0x0040 --- formerly defined explicitly as `0x0040`.
= 0x0240.
= 0x0140.
No description provided by the author
* Volume Roles **/.
No description provided by the author
= 0x02c0.
No description provided by the author
= 0x0280.
= 0x01c0 --- spec also uses the name `APFS_VOL_ROLE_SIDECAR`, but that could be an error.
= 0x0200 --- formerly named `APFS_VOL_ROLE_RESERVED_200`.
No description provided by the author
= 0x00c0.
No description provided by the author
No description provided by the author
= 0x0100.
No description provided by the author
No description provided by the author
writes to file may only append */.
A block-special file.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* B-Tree Node Flags **/.
The table of contents is allowed to contain keys that have no corresponding value.
The nodes in the B-tree use ephemeral object identifiers to link to child nodes.
The nonleaf nodes of this B-tree store a hash of their child nodes.
The keys and values in the B-tree arenʼt required to be aligned to eight-byte boundaries.
No description provided by the author
BTREE_NODE_MIN_ENTRY_COUNT
No description provided by the author
= 4 Ki.
The nodes of this B-tree are stored without object headers.
The B-tree isnʼt persisted across unmounting.
The nodes in the B-tree use physical object identifiers to link to child nodes.
Code that works with the B-tree should enable optimizations to keep the B-tree compact during sequential insertion of entries.
BTREE_TOC_ENTRY_INCREMENT
* B-Tree Table of Contents Constants **/.
BTREE_TOC_ENTRY_MAX_UNUSED
No description provided by the author
Code that works with the B-tree should enable optimizations to make comparison of keys fast.
* Checkpoint Flags **/.
A character-special file.
* Chunk Info Block Constants **/.
No description provided by the author
https://opensource.apple.com/source/copyfile/copyfile-138/copyfile.c.auto.html.
https://opensource.apple.com/source/copyfile/copyfile-138/copyfile.c.auto.html.
* case 5: specifies de-dup within the generation store.
uncompressed data in xattr (similar to but not identical to CMP_Type1).
https://opensource.apple.com/source/copyfile/copyfile-138/copyfile.c.auto.html.
Highest compression_type supported.
64k blocks.
64k blocks.
64k blocks.
64k chunked uncompressed data in resource fork.
64k blocks.
Uncompressed data in xattr.
file is compressed (some file-systems) */.
No description provided by the author
No description provided by the author
No description provided by the author
* Encryption Identifiers **/.
entitlement required for reading and writing */.
0x636d7066.
No description provided by the author
A directory.
* Extended-Field Types **/.
No description provided by the author
A block-special file.
A character-special file.
A directory.
A named pipe.
A symbolic link.
A regular file.
A socket.
* Directory Entry File Types **/.
A whiteout.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* Encryption-Rolling Checksum Block Sizes **/.
No description provided by the author
No description provided by the author
* Encryption-Rolling Constants **/.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* Encryption Rolling Flags **/.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* File Extent Constants **/.
A named pipe.
No description provided by the author
No description provided by the author
* Fusion Middle-Tree Flags **/.
No description provided by the author
* Address Markers **/.
hint that this item should not be displayed in a GUI */.
file may not be changed */.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* Integrity Metadata Version Constants **/.
* Integrity Metadata Version Constants **/.
* Integrity Metadata Version Constants **/.
* Integrity Metadata Version Constants **/.
* Inode Numbers **/.
Spec incorrectly says `0xfffff400`.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
= 3 Ki + 736.
No description provided by the author
No description provided by the author
* Keybag Tags **/.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
A symbolic link.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
do not dump file */.
No description provided by the author
file may not be removed or renamed */.
Reserved.
The current object is being reaped.
* Reaper List Flags **/.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* Reaper List Entry Flags **/.
No description provided by the author
No description provided by the author
No description provided by the author
= 4 Ki.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* Optional Container Feature Flags **/.
No description provided by the author
No description provided by the author
* Incompatible Container Feature Flags **/.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
= 64 Ki.
= 4 Ki.
= 1024 Ki = 1 Mi.
No description provided by the author
* Container Flags **/.
No description provided by the author
No description provided by the author
No description provided by the author
* Read-Only Compatible Container Feature Flags **/.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* Object Type Flags **/.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
new in 2020-06-22.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* Object Map Flags **/.
* Object Map Constants **/.
* Object Map Reaper Phases **/.
No description provided by the author
* Snapshot Flags **/.
No description provided by the author
No description provided by the author
* Object Map Value Flags **/.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
directory is opaque wrt.
* File-System Object Constants **/.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* Protection Classes **/.
No description provided by the author
No description provided by the author
No description provided by the author
A regular file.
No description provided by the author
No description provided by the author
No description provided by the author
The bit mask used to access the file type.
No description provided by the author
No description provided by the author
No description provided by the author
writes to file may only append */.
file is archived */.
file is dataless object */.
file is a firmlink */.
file may not be changed */.
Item may not be removed, renamed or mounted on */.
entitlement required for writing */.
mask of superuser changeable flags */.
snapshot inode */.
mask of superuser supported flags */.
mask of system read-only synthetic flags */.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
A socket.
No description provided by the author
No description provided by the author
* Internal-Pool Bitmap **/.
No description provided by the author
UF_TRACKED is used for dealing with document IDs.
mask of owner changeable flags */.
No description provided by the author
A whiteout.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
= 3 Ki + 732.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* Extended-Field Flags **/.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Variables

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

ApfsReapState is a apfs_reap_state_t struct.
No description provided by the author
ApfsSuperblockT is a apfs_superblock_t struct.
BTreeInfoFixedT is a btree_info_fixed_t struct.
BTreeInfoT is a btree_info_t struct.
BTreeNodeIndexNodeValT is a btn_index_node_val_t.
BTreeNodePhys is a btree_node_phys_t struct with data array.
BTreeNodePhysT is a btree_node_phys_t struct.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
CmpfRsrcHead (fields are big-endian).
DecmpfsDiskHeader this structure represents the xattr on disk; the fields below are little-endian.
DecmpfsHeader this structure represents the xattr in memory; the fields below are host-endian.
EfiJumpstart is a nx_efi_jumpstart struct.
ErRecoveryBlockPhys is a er_recovery_block_physstruct.
ErRecoveryBlockPhysT is a er_recovery_block_phys_t struct.
ErStatePhys is a er_state_phys_t struct.
ErStatePhysHeader is a er_state_phys_header_t struct.
ErStatePhysV1 is a er_state_phys (v1) struct.
ErStatePhysV1T is a er_state_phys_v1_t struct.
No description provided by the author
No description provided by the author
No description provided by the author
FusionMtVal is a fusion_mt_val_t struct.
FusionWbcListEntry is a fusion_wbc_list_entry_t struct.
FusionWbcListPhys is a fusion_wbc_list_phys struct.
FusionWbcListPhysT is a fusion_wbc_list_phys_t struct.
FusionWbcPhys is a fusion_wbc_phys_t struct.
GbitmapBlockPhys is a gbitmap_block_phys.
GbitmapBlockPhysT is a gbitmap_block_phys_t struct.
GbitmapPhys is a gbitmap_phys struct.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
JKeyT is a j_key_t.
* * Custom data structure used to store a full file-system record (i.e.
No description provided by the author
No description provided by the author
No description provided by the author
KVLocT is a kvloc_t struct.
KVOffT is a kvoff_t struct.
No description provided by the author
NxEfiJumpstartT is a nx_efi_jumpstart_t struct.
NxReaperPhysT is a nx_reaper_phys_t struct.
NxReapListPhysT is a nx_reap_list_phys_t struct.
No description provided by the author
NxSuperblockT nx_superblock_t struct.
No description provided by the author
ObjPhysT is a obj_phys_t object.
No description provided by the author
OmapCleanupState is a omap_cleanup_state_t struct.
OMapEntry is a omap_entry_t struct Custom data structure used to store the key and value of an object map entry together.
OMapKey is a omap_key_t struct.
No description provided by the author
OMapPhysT is a omap_phys_t struct.
OmapReapState is a omap_reap_state_t struct.
OMapSnapshotT is a omap_snapshot_t.
OMapVal is a omap_val_t struct.
ReaperPhys is a nx_reaper_phys struct.
ReapListEntry is a nx_reap_list_entry_t struct.
ReapListPhys is a nx_reap_list_phys struct.
No description provided by the author
SiblingKeyT is a j_sibling_key_t object.
SiblingMapKeyT is a j_sibling_map_key_t object.
SiblingMapValT is a j_sibling_map_val_t object.
SiblingValT is a j_sibling_val_t object.
No description provided by the author
No description provided by the author

# Interfaces

FSTree file system tree - credit: https://github.com/d6o/GoTree.
Printer is printer interface.

# Type aliases

No description provided by the author
FSRecords are an array of file system records.
No description provided by the author
No description provided by the author
UUID is a uuid object.
No description provided by the author