DiskImageKit creates, configures, and manages disk image files in Apple sparse image format on macOS. You represent an image with the DiskImage class and open it using OpenConfiguration and OpenConfigurationProtocol, then create new images and layers from configurations such as ASIFCreationConfiguration, ASIFLayerCreationConfiguration, and RAWCreationConfiguration. The framework supports stacked layers through the StackedImage protocol and integrates with virtual machines, and it reports failures with typed errors including CorruptedImageError, IncompatibleStackingError, InvalidBlockCountError, and UnsupportedFormatError.
Essentials 1
The principal object for representing and working with a disk image file.
- ClDiskImageThe representation of an open disk image
Opening Images 2
Configuration types and protocols that control how an existing disk image is opened.
- StOpenConfigurationA configuration to use for opening existing disk images.
- PrOpenConfigurationProtocolThe protocol for disk image open configurations.
Creating Images and Layers 3
Configurations that describe new images and layers in Apple sparse and raw formats.
- StASIFCreationConfigurationThe configuration to use to create Apple sparse image format (ASIF) disk images.
- StASIFLayerCreationConfigurationThe configuration to use to create Apple sparse image format (ASIF) disk image layers in stacked images.
- StRAWCreationConfigurationThe configuration to use to create RAW disk images.
Stacked Layers 1
The protocol that supports composing disk images from stacked layers.
- PrStackedImageThe protocol for stacked disk images that contain multiple layers.
Errors 4
Typed errors that report failures encountered while creating, opening, or stacking images.
- StCorruptedImageErrorThe disk image is corrupted or contains invalid data.
- StIncompatibleStackingErrorThe appended layer isn't compatible with the existing stack.
- StInvalidBlockCountErrorThe block count specified for the disk image is invalid (zero or negative).
- StUnsupportedFormatErrorThe disk image format isn't supported.