Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

carfile

package module

Go to main page

Versions in this module

v0

v0.6.0

Aug 26, 2026

v0.5.3

Aug 17, 2026

Changes in this version

+ func DecodePaletteImage(src []byte, width, height uint32, pixelFormat string) ([]byte, error)

+ func DecodeRLE(src []byte, width, height uint32, bytesPerPixel int) ([]byte, error)

type Deepmap2Bitmap

+ func DecodeDeepmap(src []byte, width, height uint32) (Deepmap2Bitmap, error)

+ func DecodeDeepmap2WithGeometry(src []byte, width, height uint16) (Deepmap2Bitmap, error)

v0.4.0

Aug 6, 2026

Changes in this version

+ const Version

+ func DecodeKCBC(src []byte, width, height uint32, bytesPerPixel int) ([]byte, error)

+ func DecodeLZFSE(src []byte) ([]byte, error)

+ func DecodeLZVN(src []byte, outputSize int) ([]byte, error)

+ func DecodeRenditionImage(rendition Rendition) (image.Image, error)

+ func DefaultOutputDirectory(inputPath string) string

+ type Appearance struct

+ ID uint16

+ Name string

+ type AttributeType uint32

+ func (t AttributeType) String() string

+ type AttributeValue struct

+ Name string

+ Type AttributeType

+ Value uint16

+ type BOM struct

+ Header BOMHeader

+ func ParseBOM(r io.ReaderAt, size int64) (*BOM, error)

+ func (b *BOM) Block(id uint32) ([]byte, error)

+ func (b *BOM) Info() BOMInfo

+ func (b *BOM) NamedBlock(name string) ([]byte, error)

+ func (b *BOM) TreeEntries(name string) ([]BOMTreeEntry, error)

+ func (b *BOM) VariableNames() []string

+ type BOMBlock struct

+ Length uint32

+ Offset uint32

+ type BOMHeader struct

+ IndexLength uint32

+ IndexOffset uint32

+ NumberOfBlocks uint32

+ VarsLength uint32

+ VarsOffset uint32

+ Version uint32

+ type BOMInfo struct

+ BlockCount int

+ Header BOMHeader

+ Variables map[string]uint32

+ type BOMTreeEntry struct

+ Key []byte

+ KeyBlock uint32

+ Value []byte

+ ValueBlock uint32

+ type CARHeader struct

+ AssetStorageVersion string

+ AssociatedChecksum uint32

+ ColorSpaceID uint32

+ CoreUIVersion uint32

+ KeySemantics uint32

+ MainVersion string

+ RenditionCount uint32

+ SchemaVersion uint32

+ StorageTimestamp uint32

+ StorageVersion uint32

+ Tag string

+ UUID string

+ type CSI struct

+ BitmapLengths []uint32

+ ColorSpaceID uint8

+ Flags RenditionFlags

+ Height uint32

+ Layout uint16

+ LayoutName string

+ ModificationTime uint32

+ Name string

+ Payload Payload

+ PixelFormat string

+ ScaleFactor uint32

+ TLVs []TLV

+ Tag string

+ Version uint32

+ Width uint32

+ type Catalog struct

+ Appearances []Appearance

+ BOM BOMInfo

+ Facets []Facet

+ Header CARHeader

+ KeyFormat KeyFormat

+ Metadata *ExtendedMetadata

+ Renditions []Rendition

+ func Open(path string) (*Catalog, error)

+ func Parse(r io.ReaderAt, size int64) (*Catalog, error)

+ func (c *Catalog) Export(options ExtractOptions) (ExtractResult, error)

+ func (c *Catalog) ExportImages(directory string) (ImageExportResult, error)

+ func (c *Catalog) ExportRaw(directory string) (ExportResult, error)

+ func (c *Catalog) ExportRecovered(directory string) (RecoveryResult, error)

+ func (c *Catalog) ExportResources(directory string) (RecoveryResult, error)

+ func (c *Catalog) ExportXCAssets(directory string) (RecoveryResult, error)

+ type Deepmap2Bitmap = deepmap2.Bitmap

+ func DecodeDeepmap2(src []byte) (Deepmap2Bitmap, error)

+ type ExportRecord struct

+ AssetName string

+ Compression string

+ File string

+ Index int

+ Layout string

+ LinkedKey []AttributeValue

+ Openable bool

+ PixelFormat string

+ RenditionName string

+ Status string

+ type ExportResult struct

+ Directory string

+ Files []ExportRecord

+ Skipped int

+ Written int

+ type ExtendedMetadata struct

+ AuthoringTool string

+ DeploymentPlatform string

+ DeploymentPlatformVersion string

+ Tag string

+ ThinningArguments string

+ type ExtractOptions struct

+ Format OutputFormat

+ Includes []string

+ OutputDirectory string

+ Progress func(Progress)

+ type ExtractResult struct

+ Failed int

+ Format OutputFormat

+ OutputDirectory string

+ Skipped int

+ Written int

+ func ExtractFile(path string, options ExtractOptions) (ExtractResult, error)

+ type Facet struct

+ Attributes []AttributeValue

+ HotSpotX uint16

+ HotSpotY uint16

+ Name string

+ type ImageExportRecord struct

+ AssetName string

+ Compression string

+ Error string

+ File string

+ Index int

+ Name string

+ type ImageExportResult struct

+ Directory string

+ Failed int

+ Files []ImageExportRecord

+ Written int

+ type KeyFormat struct

+ AttributeNames []string

+ Attributes []AttributeType

+ Tag string

+ Version uint32

+ type OutputFormat string

+ const FormatJSON

+ const FormatPNG

+ const FormatRaw

+ const FormatResources

+ const FormatXCAssets

+ func ParseOutputFormat(value string) (OutputFormat, error)

+ type Payload struct

+ ColorComponents []float64

+ ColorSpaceID *uint32

+ Compression string

+ CompressionType *uint32

+ Data []byte

+ DeclaredLength uint32

+ Length int

+ Tag string

+ Version uint32

+ type PixelRect struct

+ Height uint32

+ Width uint32

+ X uint32

+ Y uint32

+ type Progress struct

+ AssetName string

+ Current int

+ FileName string

+ RenditionIndex int

+ Total int

+ type RecoveryRecord struct

+ AssetName string

+ Error string

+ File string

+ Index int

+ Mode string

+ Name string

+ TargetIndex *int

+ type RecoveryResult struct

+ AssetSets int

+ CatalogDirectory string

+ CopiedOriginals int

+ Cropped int

+ Decoded int

+ Directory string

+ Duplicates int

+ Failed int

+ Files []RecoveryRecord

+ Written int

+ type Rendition struct

+ AssetName string

+ CSI CSI

+ Key []AttributeValue

+ type RenditionFlags struct

+ BitmapEncoding uint8

+ ExcludedFromContrastFilter bool

+ Flippable bool

+ HeaderFlaggedFPO bool

+ Opaque bool

+ OptOutOfThinning bool

+ PreservedVectorRepresentation bool

+ Raw uint32

+ Tintable bool

+ VectorBased bool

+ type TLV struct

+ Hex string

+ Length uint32

+ LinkedKey []AttributeValue

+ LinkedLayout *uint16

+ LinkedRect *PixelRect

+ Name string

+ Text string

+ Type uint32