zip

README

zip

Simple zip utility with a pluggable filesystem backend.

go get github.com/jackmordaunt/zip

The filesystem defaults to afero.OsFs, which operates on the host OS native filesystem.

Example use:

func main() {
        _ = zip.Create("path/to/archive.zip", "path/to/source")
        _ = zip.Extract("path/to/achive.zip", "path/to/dest")
}

To set the filesystem backend:

func main() {
        filesystem := afero.NewMemMapFs()
        zip.SetFs(filesystem)
        
        _ = zip.Create("path/to/archive.zip", "path/to/source")
        _ = zip.Extract("path/to/achive.zip", "path/to/dest")
}

Documentation

Overview

Package zip provides an easy way to create and extract zip archives with a pluggable filesystem backend using `afero.Fs`.

Note: No compression is performed in the current implementation.

Index

• func Create(archive, source string) error
• func Extract(archive, dest string) error
• func SetFs(filesystem afero.Fs)

Functions

func Create

func Create(archive, source string) error

Create a zip archive at `archive` with the contents of `source`.

func Extract

func Extract(archive, dest string) error

Extract the contents of a zip archive into `dest`.

func SetFs

func SetFs(filesystem afero.Fs)

SetFs to the provided implementation.