extract

README

Extract

import "github.com/codeclysm/extract"

Package extract allows to extract archives in zip, tar.gz or tar.bz2 formats easily.

Most of the time you'll just need to call the proper function with a buffer and a destination:

data, _ := ioutil.ReadFile("path/to/file.tar.bz2")
buffer := bytes.NewBuffer(data)
extract.TarBz2(data, "/path/where/to/extract", nil)

Sometimes you'll want a bit more control over the files, such as extracting a subfolder of the archive. In this cases you can specify a renamer func that will change the path for every file:

var shift = func(path string) string {
    parts := strings.Split(path, string(filepath.Separator))
    parts = parts[1:]
    return strings.Join(parts, string(filepath.Separator))
}
extract.TarBz2(data, "/path/where/to/extract", shift)

If you don't know which archive you're dealing with (life really is always a surprise) you can use Archive, which will infer the type of archive from the first bytes

extract.Archive(data, "/path/where/to/extract", nil)

Documentation

Overview

Package extract allows to extract archives in zip, tar.gz or tar.bz2 formats easily.

Most of the time you'll just need to call the proper function with a buffer and a destination:

data, _ := ioutil.ReadFile("path/to/file.tar.bz2")
buffer := bytes.NewBuffer(data)
extract.TarBz2(data, "/path/where/to/extract", nil)

```

Sometimes you'll want a bit more control over the files, such as extracting a subfolder of the archive. In this cases you can specify a renamer func that will change the path for every file:

var shift = func(path string) string {
	parts := strings.Split(path, string(filepath.Separator))
	parts = parts[1:]
	return strings.Join(parts, string(filepath.Separator))
}
extract.TarBz2(data, "/path/where/to/extract", shift)

```

If you don't know which archive you're dealing with (life really is always a surprise) you can use Archive, which will infer the type of archive from the first bytes

extract.Archive(data, "/path/where/to/extract", nil)

Index

• func Archive(body io.Reader, location string, rename Renamer) error
• func Bz2(body io.Reader, location string, rename Renamer) error
• func Gz(body io.Reader, location string, rename Renamer) error
• func Tar(body io.Reader, location string, rename Renamer) error
• func Zip(body io.Reader, location string, rename Renamer) error
• type Renamer

Functions

func Archive

func Archive(body io.Reader, location string, rename Renamer) error

Archive extracts a generic archived stream of data in the specified location. It automatically detects the archive type and accepts a rename function to handle the names of the files. If the file is not an archive, an error is returned.

func Bz2

func Bz2(body io.Reader, location string, rename Renamer) error

Bz2 extracts a .bz2 or .tar.bz2 archived stream of data in the specified location. It accepts a rename function to handle the names of the files (see the example)

func Gz

func Gz(body io.Reader, location string, rename Renamer) error

Gz extracts a .gz or .tar.gz archived stream of data in the specified location. It accepts a rename function to handle the names of the files (see the example)

func Tar

func Tar(body io.Reader, location string, rename Renamer) error

Tar extracts a .tar archived stream of data in the specified location. It accepts a rename function to handle the names of the files (see the example)

func Zip

func Zip(body io.Reader, location string, rename Renamer) error

Zip extracts a .zip archived stream of data in the specified location. It accepts a rename function to handle the names of the files (see the example).

Types

type Renamer

type Renamer func(string) string

Renamer is a function that can be used to rename the files when you're extracting them. For example you may want to only extract files with a certain pattern. If you return an empty string they won't be extracted.