©
本文档使用 PHP中文网手册 发布
import "archive/tar"
概述
索引
示例
概述
Package tar 实现对 tar 档案的访问。它的目的是涵盖大部分的变体（variations），其中包括 GNU 和 BSD tar生成的包。
参考：
http://www.freebsd.org/cgi/man.cgi?query=tar&sektion=5http://www.gnu.org/software/tar/manual/html_node/Standard.html http://pubs.opengroup.org/onlinepubs/9699919799/utilities/pax.html
示例
package mainimport ("archive/tar""bytes""fmt""io""log""os")func main() {// 创建一个缓冲区来写入我们的存档。
buf := new(bytes.Buffer)// 创建一个新的tar存档。
tw := tar.NewWriter(buf)// 将一些文件添加到存档中。var files = []struct {
Name, Body string}{{"readme.txt", "This archive contains some text files."},{"gopher.txt", "Gopher names:\nGeorge\nGeoffrey\nGonzo"},{"todo.txt", "Get animal handling license."},}for _, file := range files {
hdr := &tar.Header{
Name: file.Name,
Mode: 0600,
Size: int64(len(file.Body)),}if err := tw.WriteHeader(hdr); err != nil {
log.Fatalln(err)}if _, err := tw.Write([]byte(file.Body)); err != nil {
log.Fatalln(err)}}// 确保在Close时检查错误。if err := tw.Close(); err != nil {
log.Fatalln(err)}// 打开tar档案以供阅读。
r := bytes.NewReader(buf.Bytes())
tr := tar.NewReader(r)// 迭代档案中的文件。for {
hdr, err := tr.Next()if err == io.EOF {// tar归档结束break}if err != nil {
log.Fatalln(err)}
fmt.Printf("Contents of %s:\n", hdr.Name)if _, err := io.Copy(os.Stdout, tr); err != nil {
log.Fatalln(err)}
fmt.Println()}}索引
Constants
Variables
type Header
func FileInfoHeader(fi os.FileInfo, link string) (*Header, error)
func (h *Header) FileInfo() os.FileInfo
type Reader
func NewReader(r io.Reader) *Reader
func (tr *Reader) Next() (*Header, error)
func (tr *Reader) Read(b []byte) (int, error)
type Writer
func NewWriter(w io.Writer) *Writer
func (tw *Writer) Close() error
func (tw *Writer) Flush() error
func (tw *Writer) Write(b []byte) (n int, err error)
func (tw *Writer) WriteHeader(hdr *Header) error
示例
包
Package files （包文件）
common.go format.go reader.go stat_atim.go stat_unix.go strconv.go writer.go
常量
标题类型标志。
const ( TypeReg = '0' // 普通文件 TypeRegA = '\x00' // 普通文件 TypeLink = '1' // 硬链接(hard link) TypeSymlink = '2' // 符号链接 TypeChar = '3' // 字符设备节点 TypeBlock = '4' // 块设备节点 TypeDir = '5' // 目录 TypeFifo = '6' // fifo节点 TypeCont = '7' // 保留 TypeXHeader = 'x' // 扩展标题 TypeXGlobalHeader = 'g' // 全局扩展标题 TypeGNULongName = 'L' // 下一个文件名称很长 TypeGNULongLink = 'K' // 接下来将文件符号链接到一个带有长名字的文件 TypeGNUSparse = 'S' // 稀疏文件(sparse file))
变量
var (
ErrWriteTooLong = errors.New("archive/tar: write too long")
ErrFieldTooLong = errors.New("archive/tar: header field too long")
ErrWriteAfterClose = errors.New("archive/tar: write after close"))var (
ErrHeader = errors.New("archive/tar: invalid tar header"))type Header
标题代表 tar 中的单个标题。有些字段可能不会填充。
type Header struct {
Name string // 头文件条目的名称
Mode int64 // 许可和模式位
Uid int // 所有者的用户ID
Gid int // 所有者的组ID
Size int64 // 长度以字节为单位
ModTime time.Time // 修改时间
Typeflag byte // 标题条目的类型
Linkname string // 链接的目标名称
Uname string // 所有者的用户名
Gname string // 所有者的组名称
Devmajor int64 // 字符或块设备的主要数量
Devminor int64 // 少量的字符或块设备
AccessTime time.Time // 访问时间
ChangeTime time.Time // 状态更改时间
Xattrs map[string]string}func FileInfoHeader(fi os.FileInfo, link string) (*Header, error)
FileInfoHeader 从 fi 创建一个部分填充的 Header 。如果 fi 描述符号链接， FileInfoHeader 将链接记录为链接目标。如果 fi 描述一个目录，则会在该名称后附加一个斜杠。因为 os.FileInfo 的 Name 方法仅返回它描述的文件的基本名称，所以可能需要修改返回的头的 Name 字段以提供文件的完整路径名。
func (*Header) FileInfo
func (h *Header) FileInfo() os.FileInfo
FileInfo 为 Header 返回一个 os.FileInfo。
type Reader
Reader 提供对 tar 档案内容的顺序访问。tar 档案由一系列文件组成。Next 方法前进到存档中的下一个文件（包括第一个文件），然后可以将其视为一个 io.Reader 来访问该文件的数据。
type Reader struct { // contains filtered or unexported fields}func NewReader
func NewReader(r io.Reader) *Reader
NewReader 从 r 创建一个新的 Reader 阅读器。
func (*Reader) Next
func (tr *Reader) Next() (*Header, error)
接下来前进到 tar 档案中的下一个条目。
在输入结束时返回 io.EOF 。
func (*Reader) Read
func (tr *Reader) Read(b []byte) (int, error)
读取 tar 档案中当前条目的读取内容。当它到达该条目的末尾时，它返回0, io.EOF，直到下一个被调用前进到下一个条目。
无论 Header.Size 声明如何，在 TypeLink ，TypeSymLink，TypeChar， TypeBlock ，TypeDir 和 TypeFifo 等特殊类型上调用Read都会返回0, io.EOF 。
type Writer
Writer 提供 POSIX.1 格式的 tar 存档的顺序写入。tar 档案由一系列文件组成。调用 WriteHeader 开始一个新文件，然后调用 Write 来提供该文件的数据，最多写入 hdr.Size 字节。
type Writer struct { // 包含过滤或未导出的字段}func NewWriter
func NewWriter(w io.Writer) *Writer
NewWriter 创建一个写入 w 的新 Writer。
func (*Writer) Close
func (tw *Writer) Close() error
关闭 tar，刷新任何未写入的数据。
func (*Writer) Flush
func (tw *Writer) Flush() error
刷新结束写入当前文件（可选）。
func (*Writer) Write
func (tw *Writer) Write(b []byte) (n int, err error)
Write，写入 tar 中的当前条目。如果在 WriteHeader 之后写入超过 hdr.Size 字节，写返回错误 ErrWriteTooLong 。
func (*Writer) WriteHeader
func (tw *Writer) WriteHeader(hdr *Header) error
WriteHeader，写入 hdr 并准备接受文件的内容。如果WriteHeader 不是第一个标题，则调用 Flush 。关闭后调用将返回 ErrWriteAfterClose 。