npck

package module

v1.6.2 Latest Latest Go to latest Published: Jan 9, 2024 License: Apache-2.0 Imports: 15 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/essentialkaos/npck

Links

Open Source Insights

README ¶

Supported formats • Installation • Usage example • CI Status • License

npck is a Go package for unpacking various types of archives.

Supported formats

tar (.tar)
Gzip (.gz, .tgz, .tar.gz)
bzip2 (.bz2, .tbz2, .tar.bz2)
xz (.xz, .txz, .tar.xz)
Zstandart (.zst, .tzst, .tar.zst)
LZ4 (.lz4, .tlz4, .tar.lz4)
ZIP (.zip)

Installation

Make sure you have a working Go 1.19+ workspace (instructions), then:

go get -u github.com/essentialkaos/npck

Usage example

package main

import (
  "fmt"
  "github.com/essentialkaos/npck"
)

func main() {
  file := "file.tar.gz"
  err := npck.Unpack(file, "/home/john")

  if err != nil {
    fmt.Printf("Error: Can't unpack %s: %v\n", file, err)
    return
  }

  fmt.Printf("File %s successfully unpacked!\n", file)
}

CI Status

Branch	Status
`master`
`develop`

License

Apache License, Version 2.0

Documentation ¶

Overview ¶

Package npck provides methods for unpacking various types of archives

Examples ¶

Unpack

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrUnsupportedFormat = fmt.Errorf("Unknown or unsupported archive type")

Functions ¶

func Unpack ¶

func Unpack(file, dir string) error

Unpack unpacks given file

Example ¶

file := "file.tzg"
err := Unpack(file, "/home/bob/data")

if err != nil {
	fmt.Printf("Error: Can't unpack %s: %v\n", file, err)
	return
}

fmt.Printf("File %s successfully unpacked!\n", file)

Output:

Types ¶

This section is empty.

Source Files ¶

View all Source files

npck.go

Directories ¶

Path	Synopsis
bz2 Package bz2 provides methods for unpacking files with BZip2 compression	Package bz2 provides methods for unpacking files with BZip2 compression
gz Package gz provides methods for unpacking files with GZip compression	Package gz provides methods for unpacking files with GZip compression
lz4 Package lz4 provides methods for unpacking files with LZ4 compression	Package lz4 provides methods for unpacking files with LZ4 compression
tar Package tar provides method for unpacking tar files	Package tar provides method for unpacking tar files
tbz2 Package tbz2 provides methods for unpacking tar.bz2 files	Package tbz2 provides methods for unpacking tar.bz2 files
tgz Package tgz provides methods for unpacking tar.gz files	Package tgz provides methods for unpacking tar.gz files
tlz4 Package tlz4 provides methods for unpacking tar.lz4 files	Package tlz4 provides methods for unpacking tar.lz4 files
txz Package txz provides methods for unpacking tar.xz files	Package txz provides methods for unpacking tar.xz files
tzst Package tzst provides methods for unpacking tar.zst files	Package tzst provides methods for unpacking tar.zst files
utils Package utils provides auxiliary methods for working with archives	Package utils provides auxiliary methods for working with archives
xz Package xz provides methods for unpacking files with XZ compression	Package xz provides methods for unpacking files with XZ compression
zip Package zip provides methods for unpacking files with ZIP compression	Package zip provides methods for unpacking files with ZIP compression
zst Package zst provides methods for unpacking files with Zstandart compression	Package zst provides methods for unpacking files with Zstandart compression

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL