castor::ZipArchive Class Reference

#include <ZipArchive.hpp>

Inheritance diagram for castor::ZipArchive:

Collaboration diagram for castor::ZipArchive:

Classes
struct	Folder
struct	ZipImpl

Public Types
using	FolderList = List< Folder >

Public Member Functions
CU_API	ZipArchive (Path const &path, File::OpenMode mode)
	Default constructor.
CU_API	~ZipArchive () noexcept
	Destructor.
CU_API bool	deflate () const
	Deflates an archive.
CU_API bool	inflate (Path const &folder)
	Inflates the archive.
CU_API void	addFile (Path const &file)
	adds a file to the archive
CU_API void	removeFile (Path const &fileName)
	Removes a file for the archive.
CU_API bool	findFolder (String const &folder) const
	Looks for a folder into the archive.
CU_API bool	findFile (String const &file) const
	Looks for a file into the archive.

Additional Inherited Members
Protected Member Functions inherited from castor::NonMovable
	NonMovable ()=default
	Constructor.
	~NonMovable () noexcept=default
	Destructor.

Member Typedef Documentation

FolderList

using castor::ZipArchive::FolderList = List< Folder >

Constructor & Destructor Documentation

ZipArchive()

CU_API castor::ZipArchive::ZipArchive	(	Path const &	path,
		File::OpenMode	mode )

Default constructor.

Parameters

[in]	path	The archive path name
[in]	mode	The open mode

~ZipArchive()

CU_API castor::ZipArchive::~ZipArchive ( )

noexcept

Destructor.

Member Function Documentation

addFile()

CU_API void castor::ZipArchive::addFile

(

Path const &

file

)

adds a file to the archive

Parameters

[in]

file

The file path

deflate()

CU_API bool castor::ZipArchive::deflate

(

)

const

Deflates an archive.

findFile()

CU_API bool castor::ZipArchive::findFile

(

String const &

file

)

const

Looks for a file into the archive.

Parameters

[in]

file

The file name

findFolder()

CU_API bool castor::ZipArchive::findFolder

(

String const &

folder

)

const

Looks for a folder into the archive.

Parameters

[in]

folder

The folder name

inflate()

CU_API bool castor::ZipArchive::inflate

(

Path const &

folder

)

Inflates the archive.

Parameters

[in]

folder

The archive output folder

removeFile()

CU_API void castor::ZipArchive::removeFile

(

Path const &

fileName

)

Removes a file for the archive.

Parameters

[in]

fileName

The file path

---

The documentation for this class was generated from the following file:

• CastorUtils/Data/ZipArchive.hpp