API

`#archive/tar`

import: #archive/tar

counts: 5 函数, 7 方法, 4 类型, 7 常量, 0 方法集

ustar 子集：Header + Reader/Writer。归档为 owning 字符串。

`const block_size`

XuAPI

pub const block_size = 512

用途

公开常量 `block_size`。值为 `512`

参数

无

`const type_reg`

XuAPI

pub const type_reg = 48

用途

公开常量 `type_reg`。值为 `48`

参数

无

`const type_link`

XuAPI

pub const type_link = 49

用途

公开常量 `type_link`。值为 `49`

参数

无

`const type_symlink`

XuAPI

pub const type_symlink = 50

用途

公开常量 `type_symlink`。值为 `50`

参数

无

`const type_dir`

XuAPI

pub const type_dir = 53

用途

公开常量 `type_dir`。值为 `53`

参数

无

`const type_gnu_longlink`

XuAPI

pub const type_gnu_longlink = 75

用途

公开常量 `type_gnu_longlink`。值为 `75`

参数

无

`const type_gnu_longname`

XuAPI

pub const type_gnu_longname = 76

用途

公开常量 `type_gnu_longname`。值为 `76`

参数

无

`struct Header`

XuAPI

pub struct Header {
    pub name string
    pub size int
    pub mode int
    pub typeflag int
    pub linkname string
    pub uname string
    pub gname string
    pub mtime int
}

用途

公开结构体 `Header`。

参数

name string: 名字
size int: 字段（int）
mode int: 模式
typeflag int: 字段（int）
linkname string: 字段（string）
uname string: 字段（string）
gname string: 字段（string）
mtime int: 字段（int）

`struct File`

XuAPI

pub struct File {
    pub name string
    pub size int
    pub mode int
    pub typeflag int
    pub linkname string
    pub uname string
    pub gname string
    pub mtime int
    pub body string
}

用途

公开结构体 `File`。

参数

name string: 名字
size int: 字段（int）
mode int: 模式
typeflag int: 字段（int）
linkname string: 字段（string）
uname string: 字段（string）
gname string: 字段（string）
mtime int: 字段（int）
body string: 正文

`struct Reader`

XuAPI

pub struct Reader {
    pub data string
    pub pos int
}

用途

公开结构体 `Reader`。

参数

data string: 数据
pos int: 字段（int）

`struct Writer`

XuAPI

pub struct Writer {
    pub buf string
    pub closed int
    pub nfiles int
}

用途

公开结构体 `Writer`。

参数

buf string: 缓冲
closed int: 字段（int）
nfiles int: 字段（int）

`new_header`

XuAPI

pub fn new_header() Header

用途

构造 header。

参数

无

Header — 该类型的值

`new_reader`

XuAPI

pub fn new_reader(data &string) Reader

用途

构造 reader。

参数

data &string: 数据（借用，调用方仍持有；类型 &string）

Reader — 该类型的值

`new_writer`

XuAPI

pub fn new_writer() Writer

用途

构造 writer。

参数

无

Writer — 该类型的值

`(&Writer) file_count`

XuAPI

pub fn (w &Writer) file_count() int

用途

`&Writer` 上的方法：文件计数。

参数

w &Writer: 接收者 &Writer（借用）

int — 该类型的值

`encode_header`

XuAPI

pub fn encode_header(h &Header) string

用途

编码。失败时 throw。

参数

h &Header: 高度或句柄（借用，调用方仍持有；类型 &Header）

string — 结果字符串

`parse_header`

XuAPI

pub fn parse_header(blk &string) Header

用途

解析为 header。失败时 throw。

参数

blk &string: blk（借用，调用方仍持有；类型 &string）

Header — 该类型的值

`(&mut Reader) next`

XuAPI

pub fn (r &mut Reader) next() File

用途

`&mut Reader` 上的方法：取出下一项；没有则按本类型约定结束。失败时 throw。

参数

r &mut Reader: 接收者 &mut Reader（可变借用）

File — 该类型的值

`(&Writer) bytes`

XuAPI

pub fn (w &Writer) bytes() string

用途

`&Writer` 上的方法：返回已缓冲的字节串。

参数

w &Writer: 接收者 &Writer（借用）

string — 结果字符串

`(&mut Writer) write_header`

XuAPI

pub fn (w &mut Writer) write_header(h &Header, body &string) int

用途

`&mut Writer` 上的方法：写入头。失败时 throw。

参数

w &mut Writer: 接收者 &mut Writer（可变借用）
h &Header: 高度或句柄（借用，调用方仍持有；类型 &Header）
body &string: 正文（借用，调用方仍持有；类型 &string）

int — 该类型的值

`(&mut Writer) write_file`

XuAPI

pub fn (w &mut Writer) write_file(name &string, body &string, mode int) int

用途

`&mut Writer` 上的方法：写入文件。失败时 throw。

参数

w &mut Writer: 接收者 &mut Writer（可变借用）
name &string: 名字（借用，调用方仍持有；类型 &string）
body &string: 正文（借用，调用方仍持有；类型 &string）
mode int: 模式（int）

int — 该类型的值

`(&mut Writer) write_dir`

XuAPI

pub fn (w &mut Writer) write_dir(name &string, mode int) int

用途

`&mut Writer` 上的方法：写入目录部分。失败时 throw。

参数

w &mut Writer: 接收者 &mut Writer（可变借用）
name &string: 名字（借用，调用方仍持有；类型 &string）
mode int: 模式（int）

int — 该类型的值

`(&mut Writer) close`

XuAPI

pub fn (w &mut Writer) close() int

用途

`&mut Writer` 上的方法：关闭资源。

参数

w &mut Writer: 接收者 &mut Writer（可变借用）

int — 该类型的值