sese::archive::ArchiveWriter类 参考

存档写入器 更多...

#include <ArchiveWriter.h>

Public 成员函数
	ArchiveWriter (io::OutputStream *output)
virtual	~ArchiveWriter ()
int	setFilterGZip ()
int	setFilterBZip2 ()
int	setFilterLZ4 ()
int	setFilterLZip ()
int	setFilterZstd ()
int	setFilterXZ ()
int	setFilterLzma ()
int	setFilterLzop ()
int	setFilterGRZip ()
int	setFilterLRZip ()
int	setFilterNone ()
int	setFormatXar ()
int	setFormatTar ()
int	setFormatZip ()
int	setFormat7z ()
int	setFormatISO ()
int	setPassword (const std::string &pwd)
int	setOptions (const std::string &opt)
int	getError ()
const char *	getErrorString ()
bool	begin ()
bool	done ()
bool	addPath (const std::filesystem::path &path)
bool	addPath (const std::filesystem::path &base, const std::filesystem::path &path)
bool	addFile (const std::filesystem::path &file)
	实体操作函数，不推荐使用
bool	addFile (const std::filesystem::path &base, const std::filesystem::path &file)
	实体操作函数，不推荐使用
bool	addDirectory (const std::filesystem::path &dir)
	实体操作函数，不推荐使用
bool	addDirectory (const std::filesystem::path &base, const std::filesystem::path &dir)
	实体操作函数，不推荐使用
bool	addStream (const std::filesystem::path &path, io::InputStream *input, size_t len)

静态 Public 成员函数
static int	openCallback (void *archive, ArchiveWriter *archive_this)
static int64_t	writeCallback (void *archive, ArchiveWriter *archive_this, const void *buffer, size_t len)
static int	closeCallback (void *archive, ArchiveWriter *archive_this)
static int	freeCallback (void *archive, ArchiveWriter *archive_this)
static const char *	passphraseCallback (void *archive, ArchiveWriter *archive_this)

Protected 属性
io::OutputStream *	output {}
void *	archive {}

详细描述

存档写入器

构造及析构函数说明

ArchiveWriter()

ArchiveWriter::ArchiveWriter ( io::OutputStream * output )

explicit

构造写入器

参数

output

输出流

引用了 passphrase() , 以及 XX.

~ArchiveWriter()

ArchiveWriter::~ArchiveWriter ( )

virtual

引用了 XX.

成员函数说明

addDirectory() [1/2]

bool ArchiveWriter::addDirectory	(	const std::filesystem::path &	base,
		const std::filesystem::path &	dir )

实体操作函数，不推荐使用

引用了 addDirectory(), sese::io::FileStream::B_READ, sese::io::FileStream::create() , 以及 XX.

addDirectory() [2/2]

bool ArchiveWriter::addDirectory

(

const std::filesystem::path &

dir

)

实体操作函数，不推荐使用

引用了 addDirectory().

被这些函数引用 addDirectory(), addDirectory() , 以及 addPath().

addFile() [1/2]

bool ArchiveWriter::addFile	(	const std::filesystem::path &	base,
		const std::filesystem::path &	file )

实体操作函数，不推荐使用

引用了 sese::io::FileStream::B_READ, sese::io::FileStream::create() , 以及 XX.

addFile() [2/2]

bool ArchiveWriter::addFile

(

const std::filesystem::path &

file

)

实体操作函数，不推荐使用

引用了 addFile().

被这些函数引用 addFile() , 以及 addPath().

addPath() [1/2]

bool ArchiveWriter::addPath	(	const std::filesystem::path &	base,
		const std::filesystem::path &	path )

实体操作函数，添加一个文件或者文件夹到当前存档指定路径中

参数

base	存档内路径
path	目标路径

返回

是否成功

引用了 addDirectory() , 以及 addFile().

addPath() [2/2]

bool ArchiveWriter::addPath

(

const std::filesystem::path &

path

)

实体操作函数，添加一个文件或者一个文件夹到当前存档根目录中

参数

path

目标路径

返回

是否成功

引用了 addPath().

被这些函数引用 addPath().

addStream()

bool ArchiveWriter::addStream	(	const std::filesystem::path &	path,
		io::InputStream *	input,
		size_t	len )

实体操作函数，从流中读取内容并写入到存档指定路径中

参数

path	存档内路径
input	输入流
len	写入大小

返回

是否成功

引用了 sese::io::InputStream::read(), WRITE , 以及 XX.

begin()

bool ArchiveWriter::begin

(

)

开始添加实体

返回

操作结果

引用了 close(), free(), open(), output, write() , 以及 XX.

closeCallback()

int ArchiveWriter::closeCallback ( void * archive, ArchiveWriter * archive_this )

static

被这些函数引用 close().

done()

bool ArchiveWriter::done

(

)

结束添加实体

返回

操作结果

引用了 XX.

freeCallback()

int ArchiveWriter::freeCallback ( void * archive, ArchiveWriter * archive_this )

static

被这些函数引用 free().

getError()

int ArchiveWriter::getError

(

)

获取当前错误码

返回

错误码

引用了 XX.

getErrorString()

const char * ArchiveWriter::getErrorString

(

)

获取当前错误信息

返回

错误信息

引用了 XX.

openCallback()

int ArchiveWriter::openCallback ( void * archive, ArchiveWriter * archive_this )

static

被这些函数引用 open().

passphraseCallback()

const char * ArchiveWriter::passphraseCallback ( void * archive, archive::ArchiveWriter * archive_this )

static

被这些函数引用 passphrase().

setFilterBZip2()

int ArchiveWriter::setFilterBZip2

(

)

引用了 XX.

setFilterGRZip()

int ArchiveWriter::setFilterGRZip

(

)

引用了 XX.

setFilterGZip()

int ArchiveWriter::setFilterGZip

(

)

引用了 XX.

setFilterLRZip()

int ArchiveWriter::setFilterLRZip

(

)

引用了 XX.

setFilterLZ4()

int ArchiveWriter::setFilterLZ4

(

)

引用了 XX.

setFilterLZip()

int ArchiveWriter::setFilterLZip

(

)

引用了 XX.

setFilterLzma()

int ArchiveWriter::setFilterLzma

(

)

引用了 XX.

setFilterLzop()

int ArchiveWriter::setFilterLzop

(

)

引用了 XX.

setFilterNone()

int ArchiveWriter::setFilterNone

(

)

引用了 XX.

setFilterXZ()

int ArchiveWriter::setFilterXZ

(

)

引用了 XX.

setFilterZstd()

int ArchiveWriter::setFilterZstd

(

)

引用了 XX.

setFormat7z()

int ArchiveWriter::setFormat7z

(

)

引用了 XX.

setFormatISO()

int ArchiveWriter::setFormatISO

(

)

引用了 XX.

setFormatTar()

int ArchiveWriter::setFormatTar

(

)

引用了 XX.

setFormatXar()

int ArchiveWriter::setFormatXar

(

)

引用了 XX.

setFormatZip()

int ArchiveWriter::setFormatZip

(

)

引用了 XX.

setOptions()

int ArchiveWriter::setOptions

(

const std::string &

opt

)

设置存档的 libarchive 选项

参数

opt

选项

返回

成功返回 0

引用了 XX.

setPassword()

int ArchiveWriter::setPassword

(

const std::string &

pwd

)

设置写入存档所使用的密码

参数

pwd

密码

返回

成功返回 0

引用了 XX.

writeCallback()

int64_t ArchiveWriter::writeCallback ( void * archive, ArchiveWriter * archive_this, const void * buffer, size_t len )

static

引用了 output , 以及 sese::io::OutputStream::write().

被这些函数引用 write().

类成员变量说明

archive

void* sese::archive::ArchiveWriter::archive {}

protected

output

io::OutputStream* sese::archive::ArchiveWriter::output {}

protected

被这些函数引用 begin() , 以及 writeCallback().

---

该类的文档由以下文件生成:

• sese/archive/ArchiveWriter.h
• sese/archive/ArchiveWriter.cpp