class holding optional parameters used to list the contents of an existing archive More...

Inheritance diagram for libdar::archive_options_listing:

Collaboration diagram for libdar::archive_options_listing:

Public Member Functions
	archive_options_listing (const archive_options_listing &ref)

	archive_options_listing (archive_options_listing &&ref) noexcept

archive_options_listing &	operator= (const archive_options_listing &ref)

archive_options_listing &	operator= (archive_options_listing &&ref) noexcept

virtual void	clear ()

void	set_info_details (bool info_details)
	whether output should be verbosed --> to be moved to shell output

void	set_selection (const mask &selection)
	mask applied to filename, only those marching it will be listed More...

void	set_subtree (const mask &subtree)
	defines the directories and files to consider More...

void	set_filter_unsaved (bool filter_unsaved)
	whether to only show entries that have their data fully saved

void	set_slicing_location (bool val)
	whether to calculate the slice location of each file

void	set_user_slicing (const infinint &slicing_first, const infinint &slicing_others)
	when slice location is performed, user may modify the slice layout of the archive More...

void	set_display_ea (bool display_ea)
	whether to fetch EA for listing More...

bool	get_info_details () const

const mask &	get_selection () const

const mask &	get_subtree () const

bool	get_filter_unsaved () const

bool	get_user_slicing (infinint &slicing_first, infinint &slicing_others) const

bool	get_slicing_location () const

bool	get_display_ea () const

Private Member Functions
void	destroy () noexcept

void	nullifyptr () noexcept

void	copy_from (const archive_options_listing &ref)

void	move_from (archive_options_listing &&ref) noexcept

Detailed Description

class holding optional parameters used to list the contents of an existing archive

Definition at line 1474 of file archive_options.hpp.

Member Function Documentation

void libdar::archive_options_listing::set_display_ea ( bool display_ea )

inline

whether to fetch EA for listing

Definition at line 1527 of file archive_options.hpp.

void libdar::archive_options_listing::set_selection ( const mask & selection )

mask applied to filename, only those marching it will be listed

void libdar::archive_options_listing::set_subtree ( const mask & subtree )

defines the directories and files to consider

Note: WARNING: The filter mechanism used here is common to all operations and works by comparing full paths, while in the other hand, paths stored in the libdar archive are all relative to what was provided as fs_root at backup time. To have this filter mecanism working in the context of listing, where no fs_root can be provided to transform relative paths to absolute paths, libdar will emulate an fs_root with the pseudo root value of the path::FAKE_ROOT field. This is invisible form the libdar API user except when relying on mask_list objects, which cannot thus receive full path as those would not be prepended by path::FAKE_ROOT as fs_root value, because fs_root prefixing is only performed for relative paths.

void libdar::archive_options_listing::set_user_slicing	(	const infinint &	slicing_first,
		const infinint &	slicing_others
	)

when slice location is performed, user may modify the slice layout of the archive

Note: this is needed for archive format older than 8 and when listing an isolated catalogue which original archive has been resized after the isolation operation. This option is not used if set_slicing_location is set to false

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