extract

Jan 10, 2025

Changes in this version

type Config

+ func (c *Config) DropFileAttributes() bool

+ func (c *Config) PreserveOwner() bool

type ConfigOption

+ func WithDropFileAttributes(drop bool) ConfigOption

+ func WithPreserveOwner(preserve bool) ConfigOption

type Target

+ Chmod func(name string, mode fs.FileMode) error

+ Chown func(name string, uid, gid int) error

+ Chtimes func(name string, atime, mtime time.Time) error

+ Lchtimes func(name string, atime, mtime time.Time) error

type TargetDisk

+ func (d *TargetDisk) Chmod(name string, mode fs.FileMode) error

+ func (d *TargetDisk) Chown(name string, uid, gid int) error

+ func (d *TargetDisk) Chtimes(name string, atime, mtime time.Time) error

+ func (d *TargetDisk) Lchtimes(name string, atime, mtime time.Time) error

type TargetMemory

+ func (m *TargetMemory) Chmod(path string, mode fs.FileMode) error

+ func (m *TargetMemory) Chown(path string, uid, gid int) error

+ func (m *TargetMemory) Chtimes(path string, atime time.Time, mtime time.Time) error

+ func (m *TargetMemory) Lchtimes(path string, atime time.Time, mtime time.Time) error

Nov 22, 2024

Changes in this version

+ var ErrFailedToReadHeader = fmt.Errorf("extract: failed to read header")

+ var ErrFailedToUnpack = fmt.Errorf("extract: failed to unpack")

+ var ErrMaxExtractionSizeExceeded = fmt.Errorf("extract: maximum extraction size exceeded")

+ var ErrMaxFilesExceeded = fmt.Errorf("extract: maximum files exceeded")

+ var ErrNoExtractorFound = fmt.Errorf("extract: no extractor found for file type")

+ var ErrUnsupportedFile = fmt.Errorf("extract: unsupported file")

+ var ErrUnsupportedFileType = fmt.Errorf("extract: unsupported file type")

+ func HasKnownArchiveExtension(name string) bool

+ func UnpackTo(ctx context.Context, t Target, dst string, src io.Reader, cfg *Config) error

+ type Config struct

+ func NewConfig(opts ...ConfigOption) *Config

+ func (c *Config) CacheInMemory() bool

+ func (c *Config) CheckExtractionSize(fileSize int64) error

+ func (c *Config) CheckMaxFiles(counter int64) error

+ func (c *Config) ContinueOnError() bool

+ func (c *Config) ContinueOnUnsupportedFiles() bool

+ func (c *Config) CreateDestination() bool

+ func (c *Config) CustomCreateDirMode() fs.FileMode

+ func (c *Config) CustomDecompressFileMode() fs.FileMode

+ func (c *Config) DenySymlinkExtraction() bool

+ func (c *Config) ExtractType() string

+ func (c *Config) Logger() logger

+ func (c *Config) MaxExtractionSize() int64

+ func (c *Config) MaxFiles() int64

+ func (c *Config) MaxInputSize() int64

+ func (c *Config) NoUntarAfterDecompression() bool

+ func (c *Config) Overwrite() bool

+ func (c *Config) Patterns() []string

+ func (c *Config) SetNoUntarAfterDecompression(b bool)

+ func (c *Config) TelemetryHook() TelemetryHook

+ func (c *Config) TraverseSymlinks() bool

+ type ConfigOption func(*Config)

+ func WithCacheInMemory(cache bool) ConfigOption

+ func WithContinueOnError(yes bool) ConfigOption

+ func WithContinueOnUnsupportedFiles(ctd bool) ConfigOption

+ func WithCreateDestination(create bool) ConfigOption

+ func WithCustomCreateDirMode(mode fs.FileMode) ConfigOption

+ func WithCustomDecompressFileMode(mode fs.FileMode) ConfigOption

+ func WithDenySymlinkExtraction(deny bool) ConfigOption

+ func WithExtractType(extractionType string) ConfigOption

+ func WithInsecureTraverseSymlinks(traverse bool) ConfigOption

+ func WithLogger(logger logger) ConfigOption

+ func WithMaxExtractionSize(maxExtractionSize int64) ConfigOption

+ func WithMaxFiles(maxFiles int64) ConfigOption

+ func WithMaxInputSize(maxInputSize int64) ConfigOption

+ func WithNoUntarAfterDecompression(disable bool) ConfigOption

+ func WithOverwrite(enable bool) ConfigOption

+ func WithPatterns(pattern ...string) ConfigOption

+ func WithTelemetryHook(hook TelemetryHook) ConfigOption

+ type Target interface

+ CreateDir func(path string, mode fs.FileMode) error

+ CreateFile func(path string, src io.Reader, mode fs.FileMode, overwrite bool, maxSize int64) (int64, error)

+ CreateSymlink func(oldname string, newname string, overwrite bool) error

+ Lstat func(path string) (fs.FileInfo, error)

+ Stat func(path string) (fs.FileInfo, error)

+ type TargetDisk struct

+ func NewTargetDisk() *TargetDisk

+ func (d *TargetDisk) CreateDir(path string, mode fs.FileMode) error

+ func (d *TargetDisk) CreateFile(path string, src io.Reader, mode fs.FileMode, overwrite bool, maxSize int64) (int64, error)

+ func (d *TargetDisk) CreateSymlink(oldname string, newname string, overwrite bool) error

+ func (d *TargetDisk) Lstat(name string) (fs.FileInfo, error)

+ func (d *TargetDisk) Stat(name string) (os.FileInfo, error)

+ type TargetMemory struct

+ func NewTargetMemory() *TargetMemory

+ func (m *TargetMemory) CreateDir(path string, mode fs.FileMode) error

+ func (m *TargetMemory) CreateFile(path string, src io.Reader, mode fs.FileMode, overwrite bool, maxSize int64) (int64, error)

+ func (m *TargetMemory) CreateSymlink(oldName string, newName string, overwrite bool) error

+ func (m *TargetMemory) Glob(pattern string) ([]string, error)

+ func (m *TargetMemory) Lstat(path string) (fs.FileInfo, error)

+ func (m *TargetMemory) Open(path string) (fs.File, error)

+ func (m *TargetMemory) ReadDir(path string) ([]fs.DirEntry, error)

+ func (m *TargetMemory) ReadFile(path string) ([]byte, error)

+ func (m *TargetMemory) Readlink(path string) (string, error)

+ func (m *TargetMemory) Remove(path string) error

+ func (m *TargetMemory) Stat(path string) (fs.FileInfo, error)

+ func (m *TargetMemory) Sub(subPath string) (fs.FS, error)

+ type TelemetryData struct

+ ExtractedDirs int64

+ ExtractedFiles int64

+ ExtractedSymlinks int64

+ ExtractedType string

+ ExtractionDuration time.Duration

+ ExtractionErrors int64

+ ExtractionSize int64

+ InputSize int64

+ LastExtractionError error

+ LastUnsupportedFile string

+ PatternMismatches int64

+ UnsupportedFiles int64

+ func (m TelemetryData) MarshalJSON() ([]byte, error)

+ func (m TelemetryData) String() string

+ type TelemetryHook func(context.Context, *TelemetryData)

+ type UnsupportedFileError struct

+ func (e *UnsupportedFileError) Filename() string

+ func (e *UnsupportedFileError) Unwrap() error

+ func (e UnsupportedFileError) Error() string

Apr 25, 2024

Changes in this version

+ const FileType7zip

+ const FileTypeBrotli

+ const FileTypeBzip2

+ const FileTypeGZip

+ const FileTypeLZ4

+ const FileTypeSnappy

+ const FileTypeTar

+ const FileTypeTarGZip

+ const FileTypeXz

+ const FileTypeZIP

+ const FileTypeZlib

+ const FileTypeZstd

+ func GetUnpackFunctionByFileName(src string) extractor.UnpackFunc

+ func ValidTypes() string

Mar 18, 2024

Changes in this version

+ func GetUnpackFunction(data []byte) extractor.UnpackFunc

+ func IsKnownArchiveFileExtension(filename string) bool

Aug 31, 2023

Changes in this version

+ func Unpack(ctx context.Context, src io.Reader, dst string, opts ...ExtractorOption) error

+ type Extractor interface

+ FileSuffix func() string

+ MagicBytes func() [][]byte

+ Offset func() int

+ SetConfig func(config *config.Config)

+ SetTarget func(target *target.Target)

+ Unpack func(ctx context.Context, src io.Reader, dst string) error

+ type ExtractorOption func(*Extractor)

+ func WithConfig(config *config.Config) ExtractorOption

+ func WithTarget(target *target.Target) ExtractorOption