The BitOutputArchive class, given a creator object, allows creating new archives. More...

#include <bit7z/bitoutputarchive.hpp>

Inheritance diagram for BitOutputArchive:

Public Member Functions
	BitOutputArchive (const BitAbstractArchiveCreator &creator)
	Constructs a BitOutputArchive object for a completely new archive.
	BitOutputArchive (const BitAbstractArchiveCreator &creator, buffer_t &&inBuffer, ArchiveStartOffset startOffset=ArchiveStartOffset::None)=delete
	Deleted overload preventing the use of a temporary input buffer.
	BitOutputArchive (const BitAbstractArchiveCreator &creator, const buffer_t &inBuffer, ArchiveStartOffset startOffset=ArchiveStartOffset::None)
	Constructs a BitOutputArchive object, opening an input file archive from the given buffer.
	BitOutputArchive (const BitAbstractArchiveCreator &creator, const tstring &inFile, ArchiveStartOffset startOffset=ArchiveStartOffset::None)
	Constructs a BitOutputArchive object, opening an (optional) input file archive.
	BitOutputArchive (const BitAbstractArchiveCreator &creator, std::istream &inStream, ArchiveStartOffset startOffset=ArchiveStartOffset::None)
	Constructs a BitOutputArchive object, reading an input file archive from the given std::istream.
virtual	~BitOutputArchive ()
	Default destructor.
void	addDirectory (const tstring &inDir)
	Adds the given directory path and all its content.
void	addDirectoryContents (const tstring &inDir, const tstring &filter, bool recursive)
	Adds the contents of the given directory path.
void	addDirectoryContents (const tstring &inDir, const tstring &filter="*", FilterPolicy policy=FilterPolicy::Include, bool recursive=true)
	Adds the contents of the given directory path.
auto	addFile (buffer_t &&inBuffer, const tstring &name) -> BitInputItem &=delete
	Deleted overload preventing the addition of a temporary buffer.
auto	addFile (const buffer_t &inBuffer, const tstring &name) -> BitInputItem &
	Adds the given buffer file, using the given name as a path when compressed in the output archive.
auto	addFile (const tstring &inFile, const tstring &name={}) -> BitInputItem &
	Adds the given file path, with an optional user-defined path to be used in the output archive.
auto	addFile (std::istream &inStream, const tstring &name) -> BitInputItem &
	Adds the given standard input stream, using the given name as a path when compressed in the output archive.
void	addFiles (const std::vector< tstring > &inFiles)
	Adds all the files in the given vector of filesystem paths.
void	addFiles (const tstring &inDir, const tstring &filter, bool recursive)
	Adds all the files inside the given directory path that match the given wildcard filter.
void	addFiles (const tstring &inDir, const tstring &filter="*", FilterPolicy policy=FilterPolicy::Include, bool recursive=true)
	Adds all the files inside the given directory path that match the given wildcard filter.
void	addItems (const std::map< tstring, tstring > &inPaths)
	Adds all the items that can be found by indexing the keys of the given filesystem paths map; the corresponding mapped values are the user-defined paths wanted inside the output archive.
void	addItems (const std::vector< std::pair< tstring, tstring > > &inPaths)
	Adds all the items that can be found by indexing the keys of the given filesystem paths map; the corresponding mapped values are the user-defined paths wanted inside the output archive.
void	addItems (const std::vector< tstring > &inPaths)
	Adds all the items that can be found by indexing the given vector of filesystem paths.
void	compressTo (buffer_t &outBuffer)
	Compresses all the items added to this object to the specified buffer.
void	compressTo (const tstring &outFile)
	Compresses all the items added to this object to the specified archive file path.
void	compressTo (std::ostream &outStream)
	Compresses all the items added to this object to the specified buffer.
auto	creator () const noexcept -> const BitAbstractArchiveCreator &
auto	handler () const noexcept -> const BitAbstractArchiveHandler &
auto	itemsCount () const -> std::uint32_t

Detailed Description

The BitOutputArchive class, given a creator object, allows creating new archives.

Constructor & Destructor Documentation

◆ BitOutputArchive() [1/5]

BitOutputArchive ( const BitAbstractArchiveCreator & creator )

explicit

Constructs a BitOutputArchive object for a completely new archive.

Parameters

creator the reference to the BitAbstractArchiveCreator object containing all the settings to be used for creating the new archive.

◆ BitOutputArchive() [2/5]

BitOutputArchive	(	const BitAbstractArchiveCreator &	creator,
		const tstring &	inFile,
		ArchiveStartOffset	startOffset = ArchiveStartOffset::None )

explicit

Constructs a BitOutputArchive object, opening an (optional) input file archive.

If a non-empty input file path is passed, the corresponding archive will be opened and used as a base for the creation of the new archive. Otherwise, the class will behave as if it is creating a completely new archive.

Parameters

creator	the reference to the BitAbstractArchiveCreator object containing all the settings to be used for creating the new archive and reading the (optional) input archive.
inFile	(optional) the path to an input archive file.
startOffset	(optional) where to search the start of the input archive within the input file.

◆ BitOutputArchive() [3/5]

BitOutputArchive	(	const BitAbstractArchiveCreator &	creator,
		const buffer_t &	inBuffer,
		ArchiveStartOffset	startOffset = ArchiveStartOffset::None )

Constructs a BitOutputArchive object, opening an input file archive from the given buffer.

If a non-empty input buffer is passed, the archive file it contains will be opened and used as a base for the creation of the new archive. Otherwise, the class will behave as if it is creating a completely new archive.

Parameters

creator	the reference to the BitAbstractArchiveCreator object containing all the settings to be used for creating the new archive and reading the (optional) input archive.
inBuffer	the buffer containing an input archive file.
startOffset	(optional) where to search the start of the input archive within the input file.

◆ BitOutputArchive() [4/5]

BitOutputArchive	(	const BitAbstractArchiveCreator &	creator,
		buffer_t &&	inBuffer,
		ArchiveStartOffset	startOffset = ArchiveStartOffset::None )

delete

Deleted overload preventing the use of a temporary input buffer.

The input archive's bytes are read lazily while compressing (to copy retained items), so the buffer must outlive the BitOutputArchive; a temporary would dangle.

◆ BitOutputArchive() [5/5]

BitOutputArchive	(	const BitAbstractArchiveCreator &	creator,
		std::istream &	inStream,
		ArchiveStartOffset	startOffset = ArchiveStartOffset::None )

Constructs a BitOutputArchive object, reading an input file archive from the given std::istream.

Parameters

creator	the reference to the BitAbstractArchiveCreator object containing all the settings to be used for creating the new archive and reading the (optional) input archive.
inStream	the standard input stream of the input archive file.
startOffset	(optional) where to search the start of the input archive within the input file.

◆ ~BitOutputArchive()

virtual ~BitOutputArchive ( )

virtual

Default destructor.

Member Function Documentation

◆ addDirectory()

void addDirectory ( const tstring & inDir )

Adds the given directory path and all its content.

Parameters

inDir the path of the directory to be added to the archive.

◆ addDirectoryContents() [1/2]

void addDirectoryContents	(	const tstring &	inDir,
		const tstring &	filter,
		bool	recursive )

Adds the contents of the given directory path.

This function iterates through the specified directory and adds its contents based on the provided wildcard filter. Optionally, the operation can be recursive, meaning it will include subdirectories and their contents.

Parameters

inDir	the directory where to search for files to be added to the output archive.
filter	the wildcard filter to be used for searching the files.
recursive	recursively search the files in the given directory and all of its subdirectories.

◆ addDirectoryContents() [2/2]

void addDirectoryContents	(	const tstring &	inDir,
		const tstring &	filter = "*",
		FilterPolicy	policy = FilterPolicy::Include,
		bool	recursive = true )

Adds the contents of the given directory path.

This function iterates through the specified directory and adds its contents based on the provided wildcard filter and policy. Optionally, the operation can be recursive, meaning it will include subdirectories and their contents.

Parameters

inDir	the directory where to search for files to be added to the output archive.
filter	(optional) the wildcard filter to be used for searching the files.
recursive	(optional) recursively search the files in the given directory and all of its subdirectories.
policy	(optional) the filtering policy to be applied to the matched items.

◆ addFile() [1/4]

auto addFile	(	buffer_t &&	inBuffer,
		const tstring &	name ) -> BitInputItem &=delete

delete

Deleted overload preventing the addition of a temporary buffer.

The added item only keeps a reference to the buffer, which is read later when compressing; a temporary would dangle, so passing one is rejected at compile time.

◆ addFile() [2/4]

auto addFile	(	const buffer_t &	inBuffer,
		const tstring &	name ) -> BitInputItem &

Adds the given buffer file, using the given name as a path when compressed in the output archive.

Parameters

inBuffer	the buffer containing the file to be added to the output archive.
name	user-defined path to be used inside the output archive.

Returns: a reference to the input item just added, valid until the next call that adds items to the archive.

◆ addFile() [3/4]

auto addFile	(	const tstring &	inFile,
		const tstring &	name = {} ) -> BitInputItem &

Adds the given file path, with an optional user-defined path to be used in the output archive.

Note: If a directory path is given, a BitException is thrown.

Parameters

inFile	the path to the filesystem file to be added to the output archive.
name	(optional) user-defined path to be used inside the output archive.

Returns: a reference to the input item just added, valid until the next call that adds items to the archive.

◆ addFile() [4/4]

auto addFile	(	std::istream &	inStream,
		const tstring &	name ) -> BitInputItem &

Adds the given standard input stream, using the given name as a path when compressed in the output archive.

Parameters

inStream	the input stream to be added.
name	the name of the file inside the output archive.

Returns: a reference to the input item just added, valid until the next call that adds items to the archive.

◆ addFiles() [1/3]

void addFiles ( const std::vector< tstring > & inFiles )

Adds all the files in the given vector of filesystem paths.

Note: Paths to directories are ignored.

Parameters

inFiles the vector of paths to files.

◆ addFiles() [2/3]

void addFiles	(	const tstring &	inDir,
		const tstring &	filter,
		bool	recursive )

Adds all the files inside the given directory path that match the given wildcard filter.

Parameters

inDir	the directory where to search for files to be added to the output archive.
filter	the wildcard filter to be used for searching the files.
recursive	recursively search the files in the given directory and all of its subdirectories.

◆ addFiles() [3/3]

void addFiles	(	const tstring &	inDir,
		const tstring &	filter = "*",
		FilterPolicy	policy = FilterPolicy::Include,
		bool	recursive = true )

Adds all the files inside the given directory path that match the given wildcard filter.

Parameters

inDir	the directory where to search for files to be added to the output archive.
filter	(optional) the wildcard filter to be used for searching the files.
recursive	(optional) recursively search the files in the given directory and all of its subdirectories.
policy	(optional) the filtering policy to be applied to the matched items.

◆ addItems() [1/3]

void addItems ( const std::map< tstring, tstring > & inPaths )

Adds all the items that can be found by indexing the keys of the given filesystem paths map; the corresponding mapped values are the user-defined paths wanted inside the output archive.

Parameters

inPaths map of filesystem paths with the corresponding user-defined path desired inside the output archive.

◆ addItems() [2/3]

void addItems ( const std::vector< std::pair< tstring, tstring > > & inPaths )

Adds all the items that can be found by indexing the keys of the given filesystem paths map; the corresponding mapped values are the user-defined paths wanted inside the output archive.

Parameters

inPaths map of filesystem paths with the corresponding user-defined path desired inside the output archive.

◆ addItems() [3/3]

void addItems ( const std::vector< tstring > & inPaths )

Adds all the items that can be found by indexing the given vector of filesystem paths.

Parameters

inPaths the vector of filesystem paths.

◆ compressTo() [1/3]

void compressTo ( buffer_t & outBuffer )

Compresses all the items added to this object to the specified buffer.

Parameters

outBuffer the output buffer.

◆ compressTo() [2/3]

void compressTo ( const tstring & outFile )

Compresses all the items added to this object to the specified archive file path.

Note: If this object was created by passing an input archive file path, and this latter is the same as the outFile path parameter, the file will be updated.

Parameters

outFile the output archive file path.

◆ compressTo() [3/3]

void compressTo ( std::ostream & outStream )

Compresses all the items added to this object to the specified buffer.

Parameters

outStream the output standard stream.

◆ creator()

auto creator ( ) const -> const BitAbstractArchiveCreator &

noexcept

Returns: a constant reference to the BitAbstractArchiveHandler object containing the settings for writing the output archive.

◆ handler()

auto handler ( ) const -> const BitAbstractArchiveHandler &

noexcept

Returns: a constant reference to the BitAbstractArchiveHandler object containing the settings for writing the output archive.

◆ itemsCount()

auto itemsCount ( ) const -> std::uint32_t

Returns: the total number of items added to the output archive object.

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

include/bit7z/bitoutputarchive.hpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ BitOutputArchive() [1/5]

◆ BitOutputArchive() [2/5]

◆ BitOutputArchive() [3/5]

◆ BitOutputArchive() [4/5]

◆ BitOutputArchive() [5/5]

◆ ~BitOutputArchive()

Member Function Documentation

◆ addDirectory()

◆ addDirectoryContents() [1/2]

◆ addDirectoryContents() [2/2]

◆ addFile() [1/4]

◆ addFile() [2/4]

◆ addFile() [3/4]

◆ addFile() [4/4]

◆ addFiles() [1/3]

◆ addFiles() [2/3]

◆ addFiles() [3/3]

◆ addItems() [1/3]

◆ addItems() [2/3]

◆ addItems() [3/3]

◆ compressTo() [1/3]

◆ compressTo() [2/3]

◆ compressTo() [3/3]

◆ creator()

◆ handler()

◆ itemsCount()