ZipFile Class Reference

Read the contents of a ZIP archive. More...

#include <cc/ZipFile>

Inheritance diagram for ZipFile:

Public Types
using	Item = String
	Item type.
Public Types inherited from Object
using	NullAccess = cc::NullAccess
	Error thrown when trying to access a null object.
using	VirginityTestFailed = cc::VirginityTestFailed
	Error thrown when trying to initialize an object with a non-virgin state.

Public Member Functions
	ZipFile (const String &path)
	Open a ZIP archive.
String	path () const
	Return the ZIP archive's file path.
bool	read (Out< String > name)
	Read next file name from the ZIP archive.
Stream	open (const String &name)
	Open a file from this ZIP archive.
SourceIterator< ZipFile >	begin ()
	Iteration start.
SourceIterator< ZipFile >	end ()
	Iteration end.
Public Member Functions inherited from Object
	Object ()=default
	Create a null object.
	operator bool () const
	Check if this is a non-null object.
bool	isNull () const
	Check if this is a null object.
int	useCount () const
	Reference count.
template<class T>
bool	is () const
	Check if this object is of type T.
template<class T>
T	as () const
	Cast this object to type T.
bool	isWeak () const
	Check if the underlying object reference is weak.
bool	operator== (const Object &other) const
	Equality operator.
std::strong_ordering	operator<=> (const Object &other) const
	Ordering operator.

Additional Inherited Members
Protected Member Functions inherited from Object
template<class T>
T	weak () const
template<class T>
void	initOnce ()
	Create the object state when called the first time.
template<class T>
void	initOncePerThread ()
	Create a distinct object state for each thread when called the first time in that thread.
	Object (State *newState)
	Initialize object with newState.
	Object (State *state, Alias)
	Object (State *state, Weak)
Object &	operator= (std::nullptr_t)
Static Protected Member Functions inherited from Object
template<class T>
static T	alias (const State *state)
	Create an alias object for the given state.
template<class T>
static T	weak (const State *state)
Protected Attributes inherited from Object
Handle< State >	me
	Internal object state

Detailed Description

Read the contents of a ZIP archive.

Todo

Rename to ZipArchive

Member Typedef Documentation

Item

using Item = String

Item type.

Constructor & Destructor Documentation

ZipFile()

ZipFile ( const String & path )

explicit

Open a ZIP archive.

Parameters

path	File path of a ZIP archive

Member Function Documentation

path()

String path

(

)

const

Return the ZIP archive's file path.

read()

bool read

(

Out< String >

name

)

Read next file name from the ZIP archive.

Parameters

name	return name of next entry

Returns

false if no more entries, else true

open()

Stream open

(

const String &

name

)

Open a file from this ZIP archive.

Parameters

name	name of the file to open

Returns

new content stream

begin()

SourceIterator< ZipFile > begin

(

)

Iteration start.

end()

SourceIterator< ZipFile > end

(

)

Iteration end.