staticlib::unzip::file_index Class Reference

Represents an index over the entries inside the ZIP file. More...

#include <staticlib/unzip/file_index.hpp>

Public Member Functions
	file_index (std::string zip_file_path)
	PIMPL-specific constructor.
file_entry	find_zip_entry (const std::string &name) const
	Returns the ZIP entry with the specified name.
const std::string &	get_zip_file_path () const
	Returns a path to the ZIP file.
const std::vector< std::string > &	get_entries () const
	Returns a list of ZIP entries names.

Detailed Description

Represents an index over the entries inside the ZIP file.

Constructor & Destructor Documentation

staticlib::unzip::file_index::file_index

(

std::string

zip_file_path

)

PIMPL-specific constructor.

Parameters

pimpl	impl object Constructor
zip_file_path	path to the ZIP file

Member Function Documentation

file_entry staticlib::unzip::file_index::find_zip_entry

(

const std::string &

name

)

const

Returns the ZIP entry with the specified name.

Parameters

name	name of ZIP entry

Returns

ZIP entry with the specified name, empty entry if not found

const std::vector<std::string>& staticlib::unzip::file_index::get_entries

(

)

const

Returns a list of ZIP entries names.

Returns

list of ZIP entries names

const std::string& staticlib::unzip::file_index::get_zip_file_path

(

)

const

Returns a path to the ZIP file.

Returns

a path to the ZIP file

---

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

• staticlib/unzip/file_index.hpp