zst

package

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

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

Documentation ¶

Overview ¶

Package zst provides methods for unpacking files with Zstandart compression

Index ¶

Variables
func Read(r io.Reader, output string) error
func Unpack(file, dir string) error

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrNilReader   = fmt.Errorf("Reader can not be nil")
	ErrEmptyInput  = fmt.Errorf("Path to input file can not be empty")
	ErrEmptyOutput = fmt.Errorf("Path to output file can not be empty")
)

Functions ¶

func Read ¶

func Read(r io.Reader, output string) error

Read reads compressed data using given reader and unpacks it to the given directory

Example ¶

file := "file.zst"
fd, err := os.OpenFile(file, os.O_RDONLY, 0)

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

err = Read(fd, "/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:

func Unpack ¶

func Unpack(file, dir string) error

Unpacks file to given directory

Example ¶

file := "file.zst"
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

zst.go

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