README
¶
tar
Package tar implements access to tar archives.
Feature
- Tar
- Gzip
- Tar files or dirs
Get started
Install
go get github.com/hslam/tar
Import
import "github.com/hslam/tar"
Usage
Example
package main
import (
"fmt"
"github.com/hslam/tar"
"os"
)
func main() {
name := "file"
targz := "file.tar.gz"
defer os.Remove(name)
defer os.Remove(targz)
file, err := os.Create(name)
if err != nil {
panic(err)
}
contents := "Hello World"
file.Write([]byte(contents))
file.Close()
tar.Targz(targz, name)
os.Remove(name)
tar.Untargz(targz)
f, err := os.Open(name)
if err != nil {
panic(err)
}
defer f.Close()
buf := make([]byte, len(contents))
f.Read(buf)
fmt.Println(string(buf))
}
Tar bytes example
package main
import (
"fmt"
"github.com/hslam/tar"
"os"
)
func main() {
targz := "file.tar.gz"
defer os.Remove(targz)
tw, err := tar.NewGzipFileWriter(targz)
if err != nil {
panic(err)
}
tw.TarBytes("file", []byte("Hello World"))
tw.Flush()
tw.Close()
tr, err := tar.NewGzipFileReader(targz)
if err != nil {
panic(err)
}
_, _, data, err := tr.NextBytes()
if err != nil {
panic(err)
}
fmt.Println(string(data))
}
Output
Hello World
License
This package is licensed under a MIT license (Copyright (c) 2020 Meng Huang)
Author
tar was written by Meng Huang.
Documentation
¶
Overview ¶
Package tar implements access to tar archives.
Index ¶
Constants ¶
const TarSuffix = ".tar"
TarSuffix represents the tar suffix.
const TargzSuffix = ".tar.gz"
TargzSuffix represents the tar gzip suffix.
Variables ¶
var ErrTooManyArgs = errors.New("too many arguments")
ErrTooManyArgs is returned when the arguments length is bigger than 1.
Functions ¶
Types ¶
type Reader ¶
Reader provides sequential access to the contents of a tar archive.
func NewFileReader ¶
NewFileReader creates a new Reader reading from file.
func NewGzipFileReader ¶
NewGzipFileReader creates a new gzip Reader reading from file.
func NewGzipReader ¶
NewGzipReader creates a new gzip Reader reading from r.
type Writer ¶
Writer provides sequential writing of a tar archive.
func NewFileWriter ¶
NewFileWriter creates a new Writer writing to file.
func NewGzipFileWriter ¶
NewGzipFileWriter creates a new gzip Writer writing to file.
func NewGzipWriter ¶
NewGzipWriter creates a new gzip Writer writing to w.
func (*Writer) Close ¶
Close closes the tar archive by flushing the padding, and writing the footer. If the current file (from a prior call to WriteHeader) is not fully written, then this returns an error.
func (*Writer) Flush ¶
Flush finishes writing the current file's block padding. The current file must be fully written before Flush can be called.
This is unnecessary as the next call to WriteHeader or Close will implicitly flush out the file's padding.
Source Files