package
4.3.0-rc.1
Repository: https://github.com/sylabs/singularity.git
Documentation: pkg.go.dev

# Functions

CheckExt3Header checks if byte content contains a valid ext3 header and returns offset where ext3 partition begin.
CheckSquashfsHeader checks if byte content contains a valid squashfs header and returns offset where squashfs partition starts.
GetSquashfsComp checks if byte content contains a valid squashfs header and returns type of compression used.
Init initializes an image object based on given path.
IsOCISIF receives a path to an image file and returns a boolean indicating whether the file is an OCI-SIF image.
IsReadOnlyFilesytem returns if the corresponding error is a read-only filesystem error or not.
NewPartitionReader searches and returns a reader for an image partition identified by name or by index, if index is less than 0 only partition with provided name will be returned if a matching entry is found.
NewSectionReader searches and returns a reader for an image section identified by name or by index, if index is less than 0 only section with provided name will be returned if a matching entry is found.
ResolvePath returns a resolved absolute path.

# Constants

DataUsage defines flag for image/partition usable as data.
ENCRYPTSQUASHFS constant for encrypted squashfs format.
ErrNoPartition corresponds to an image partition not found.
ErrNoSection corresponds to an image section not found.
EXT3 constant for ext3 format.
OCISIF constant for OCI-SIF images.
OverlayUsage defines flag for image/partition usable as overlay.
RAW constant for raw format.
RootFs partition name.
RootFsUsage defines flag for image/partition usable as root filesystem.
SANDBOX constant for directory format.
SIF constant for sif format (native image, not OCI-SIF).
SIFDescInspectMetadataJSON is the name of the SIF descriptor holding the container metadata.
SIFDescOCIConfigJSON is the name of the SIF descriptor holding the OCI configuration.
SQUASHFS constant for squashfs format.

# Variables

No description provided by the author
ErrUnknownFormat represents an unknown image format error.

# Structs

Image describes an image object, an image is composed of one or more partitions (eg: container root filesystem, overlay), image format like SIF contains descriptors pointing to chunk of data, chunks position and size are stored as image sections.
Section identifies and locates a data section in image object.

# Type aliases

No description provided by the author