cae

package module

v1.0.0 Latest Latest Go to latest Published: Aug 22, 2019 License: Apache-2.0 Imports: 3 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/Unknwon/cae

Links

Open Source Insights

README ¶

Compression and Archive Extensions

中文文档

Package cae implements PHP-like Compression and Archive Extensions.

But this package has some modifications depends on Go-style.

Reference: PHP:Compression and Archive Extensions.

Code Convention: based on Go Code Convention.

Implementations

Package zip(Go Walker) and tz(Go Walker) both enable you to transparently read or write ZIP/TAR.GZ compressed archives and the files inside them.

Features:
- Add file or directory from everywhere to archive, no one-to-one limitation.
- Extract part of entries, not all at once.
- Stream data directly into io.Writer without any file system storage.

Test cases and Coverage

All subpackages use GoConvey to write test cases, and coverage is more than 80 percent.

Use cases

Gogs: self hosted Git service in the Go Programming Language.
GoBlog: personal blogging application.
GoBuild: online Go cross-platform compilation and download service.

License

This project is under Apache v2 License. See the LICENSE file for the full license text.

Documentation ¶

Overview ¶

Package cae implements PHP-like Compression and Archive Extensions.

Index ¶

func Copy(dest, src string) error
func HasPrefix(name string, prefixes []string) bool
func IsEntry(name string, entries []string) bool
func IsExist(path string) bool
func IsFilter(name string) bool
type HookFunc
type Streamer

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Copy ¶

func Copy(dest, src string) error

Copy copies file from source to target path.

func HasPrefix ¶

func HasPrefix(name string, prefixes []string) bool

HasPrefix returns true if name has any string in given slice as prefix.

func IsEntry ¶

func IsEntry(name string, entries []string) bool

IsEntry returns true if name equals to any string in given slice.

func IsExist ¶

func IsExist(path string) bool

IsExist returns true if given path is a file or directory.

func IsFilter ¶

func IsFilter(name string) bool

IsFilter returns true if given name matches any of global filter rule.

Types ¶

type HookFunc ¶

type HookFunc func(string, os.FileInfo) error

A HookFunc represents a middleware for packing and extracting archive.

type Streamer ¶

type Streamer interface {
	StreamFile(string, os.FileInfo, []byte) error
	StreamReader(string, os.FileInfo, io.Reader) error
	Close() error
}

A Streamer describes an streamable archive object.

Source Files ¶

View all Source files

cae.go

Directories ¶

Path	Synopsis
cae cae is a command-line tool for operating ZIP/TAR.GZ files based on cae package.	cae is a command-line tool for operating ZIP/TAR.GZ files based on cae package.
tz Package tz enables you to transparently read or write TAR.GZ compressed archives and the files inside them.	Package tz enables you to transparently read or write TAR.GZ compressed archives and the files inside them.
zip Package zip enables you to transparently read or write ZIP compressed archives and the files inside them.	Package zip enables you to transparently read or write ZIP compressed archives and the files inside them.

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