?
This document uses PHP Chinese website manual Release
import "archive/tar"
概述
索引
示例
Package tar 實(shí)現(xiàn)對 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() {// 創(chuàng)建一個(gè)緩沖區(qū)來寫入我們的存檔。 buf := new(bytes.Buffer)// 創(chuàng)建一個(gè)新的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時(shí)檢查錯(cuò)誤。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歸檔結(jié)束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
包
common.go format.go reader.go stat_atim.go stat_unix.go strconv.go writer.go
標(biāo)題類型標(biāo)志。
const ( TypeReg = '0' // 普通文件 TypeRegA = '\x00' // 普通文件 TypeLink = '1' // 硬鏈接(hard link) TypeSymlink = '2' // 符號鏈接 TypeChar = '3' // 字符設(shè)備節(jié)點(diǎn) TypeBlock = '4' // 塊設(shè)備節(jié)點(diǎn) TypeDir = '5' // 目錄 TypeFifo = '6' // fifo節(jié)點(diǎn) TypeCont = '7' // 保留 TypeXHeader = 'x' // 擴(kuò)展標(biāo)題 TypeXGlobalHeader = 'g' // 全局?jǐn)U展標(biāo)題 TypeGNULongName = 'L' // 下一個(gè)文件名稱很長 TypeGNULongLink = 'K' // 接下來將文件符號鏈接到一個(gè)帶有長名字的文件 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"))
標(biāo)題代表 tar 中的單個(gè)標(biāo)題。有些字段可能不會填充。
type Header struct { Name string // 頭文件條目的名稱 Mode int64 // 許可和模式位 Uid int // 所有者的用戶ID Gid int // 所有者的組ID Size int64 // 長度以字節(jié)為單位 ModTime time.Time // 修改時(shí)間 Typeflag byte // 標(biāo)題條目的類型 Linkname string // 鏈接的目標(biāo)名稱 Uname string // 所有者的用戶名 Gname string // 所有者的組名稱 Devmajor int64 // 字符或塊設(shè)備的主要數(shù)量 Devminor int64 // 少量的字符或塊設(shè)備 AccessTime time.Time // 訪問時(shí)間 ChangeTime time.Time // 狀態(tài)更改時(shí)間 Xattrs map[string]string}
func FileInfoHeader(fi os.FileInfo, link string) (*Header, error)
FileInfoHeader 從 fi 創(chuàng)建一個(gè)部分填充的 Header 。如果 fi 描述符號鏈接, FileInfoHeader 將鏈接記錄為鏈接目標(biāo)。如果 fi 描述一個(gè)目錄,則會在該名稱后附加一個(gè)斜杠。因?yàn)?os.FileInfo 的 Name 方法僅返回它描述的文件的基本名稱,所以可能需要修改返回的頭的 Name 字段以提供文件的完整路徑名。
func (h *Header) FileInfo() os.FileInfo
FileInfo 為 Header 返回一個(gè) os.FileInfo。
Reader 提供對 tar 檔案內(nèi)容的順序訪問。tar 檔案由一系列文件組成。Next 方法前進(jìn)到存檔中的下一個(gè)文件(包括第一個(gè)文件),然后可以將其視為一個(gè) io.Reader 來訪問該文件的數(shù)據(jù)。
type Reader struct { // contains filtered or unexported fields}
func NewReader(r io.Reader) *Reader
NewReader 從 r 創(chuàng)建一個(gè)新的 Reader 閱讀器。
func (tr *Reader) Next() (*Header, error)
接下來前進(jìn)到 tar 檔案中的下一個(gè)條目。
在輸入結(jié)束時(shí)返回 io.EOF 。
func (tr *Reader) Read(b []byte) (int, error)
讀取 tar 檔案中當(dāng)前條目的讀取內(nèi)容。當(dāng)它到達(dá)該條目的末尾時(shí),它返回0, io.EOF,直到下一個(gè)被調(diào)用前進(jìn)到下一個(gè)條目。
無論 Header.Size 聲明如何,在 TypeLink ,TypeSymLink,TypeChar, TypeBlock ,TypeDir 和 TypeFifo 等特殊類型上調(diào)用Read都會返回0, io.EOF 。
Writer 提供 POSIX.1 格式的 tar 存檔的順序?qū)懭?。tar 檔案由一系列文件組成。調(diào)用 WriteHeader 開始一個(gè)新文件,然后調(diào)用 Write 來提供該文件的數(shù)據(jù),最多寫入 hdr.Size 字節(jié)。
type Writer struct { // 包含過濾或未導(dǎo)出的字段}
func NewWriter(w io.Writer) *Writer
NewWriter 創(chuàng)建一個(gè)寫入 w 的新 Writer。
func (tw *Writer) Close() error
關(guān)閉 tar,刷新任何未寫入的數(shù)據(jù)。
func (tw *Writer) Flush() error
刷新結(jié)束寫入當(dāng)前文件(可選)。
func (tw *Writer) Write(b []byte) (n int, err error)
Write,寫入 tar 中的當(dāng)前條目。如果在 WriteHeader 之后寫入超過 hdr.Size 字節(jié),寫返回錯(cuò)誤 ErrWriteTooLong 。
func (tw *Writer) WriteHeader(hdr *Header) error
WriteHeader,寫入 hdr 并準(zhǔn)備接受文件的內(nèi)容。如果WriteHeader 不是第一個(gè)標(biāo)題,則調(diào)用 Flush 。關(guān)閉后調(diào)用將返回 ErrWriteAfterClose 。