Disk ARchive  2.7.15
Full featured and portable backup and archiving tool
Public Member Functions | Private Member Functions | Private Attributes | List of all members
libdar::archive_options_test Class Reference

class holding optional parameters used to test the structure coherence of an existing archive More...

#include <archive_options.hpp>

+ Collaboration diagram for libdar::archive_options_test:

Public Member Functions

 archive_options_test (const archive_options_test &ref)
 
 archive_options_test (archive_options_test &&ref) noexcept
 
archive_options_testoperator= (const archive_options_test &ref)
 
archive_options_testoperator= (archive_options_test &&ref) noexcept
 
void clear ()
 
void set_selection (const mask &selection)
 list of filenames to consider (directory not concerned by this fiter)
 
void set_subtree (const mask &subtree)
 defines the directories and files to consider More...
 
void set_info_details (bool info_details)
 
void set_display_skipped (bool display_skipped)
 whether to display files that have been excluded by filters
 
void set_display_treated (bool display_treated, bool only_dir)
 
void set_empty (bool empty)
 dry-run exectution if set to true
 
const maskget_selection () const
 
const maskget_subtree () const
 
bool get_info_details () const
 
bool get_display_treated () const
 
bool get_display_treated_only_dir () const
 
bool get_display_skipped () const
 
bool get_empty () const
 

Private Member Functions

void destroy () noexcept
 
void nullifyptr () noexcept
 
void copy_from (const archive_options_test &ref)
 
void move_from (archive_options_test &&ref) noexcept
 

Private Attributes

maskx_selection
 
maskx_subtree
 
bool x_info_details
 
bool x_display_treated
 
bool x_display_treated_only_dir
 
bool x_display_skipped
 
bool x_empty
 

Detailed Description

class holding optional parameters used to test the structure coherence of an existing archive

Definition at line 1692 of file archive_options.hpp.

Member Function Documentation

◆ set_display_treated()

void libdar::archive_options_test::set_display_treated ( bool  display_treated,
bool  only_dir 
)
inline

defines whether to show treated files

Parameters
[in]display_treatedtrue to display processed inodes
[in]only_dironly display the current directory under processing, not its individual files

Definition at line 1737 of file archive_options.hpp.

◆ set_info_details()

void libdar::archive_options_test::set_info_details ( bool  info_details)
inline

whether the user needs detailed output of the operation

Note
in API 5.5.x and before this switch drove the displaying of processing messages and treated files. now it only drives the display of processing messages, use set_display_treated to define whether files under treatement should be display or not

Definition at line 1729 of file archive_options.hpp.

◆ set_subtree()

void libdar::archive_options_test::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 testing, 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.

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