Disk ARchive  2.5.2
Full featured and portable backup and archiving tool
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines
Public Types | Public Member Functions
libdar::archive_options_extract Class Reference

class holding optional parameters used to extract files from an existing archive More...

#include <archive_options.hpp>

Inherits libdar::on_pool.

List of all members.

Public Types

enum  t_dirty { dirty_ignore, dirty_warn, dirty_ok }

Public Member Functions

 archive_options_extract (const archive_options_extract &ref)
const archive_options_extractoperator= (const archive_options_extract &ref)
void clear ()
void set_selection (const mask &selection)
 defines the filenames to only save (except directory) as those that match the given mask
void set_subtree (const mask &subtree)
 defines the directory and files to consider (this mask will be applied to the absolute path of files being proceeded)
void set_warn_over (bool warn_over)
 defines whether a warning shall be issued before overwriting
void set_info_details (bool info_details)
void set_display_treated (bool display_treated, bool only_dir)
void set_display_skipped (bool display_skipped)
 whether to display files that have been excluded by filters
void set_ea_mask (const mask &ea_mask)
 defines which Extended Attributes to save
void set_flat (bool flat)
 whether to ignore directory structure and restore all files in the same directory
void set_what_to_check (cat_inode::comparison_fields what_to_check)
 fields to consider when comparing inodes with those on filesystem to determine if it is more recent (see cat_inode::comparison_fields enumeration), also defines whether mtime has to be restored (cf_mtime) whether permission have to be too (cf_ignore_owner) whether ownership has to be restored too (cf_all)
void set_warn_remove_no_match (bool warn_remove_no_match)
 whether a warning must be issue if a file to remove does not match the expected type of file
void set_empty (bool empty)
 defines whether we need to store ignored directories as empty
void set_empty_dir (bool empty_dir)
 whether to restore directories where no file has been triggered for backup (no file/inode change, excluded files,...)
void set_dirty_behavior (bool ignore, bool warn)
 whether to restore dirty files (those that changed during backup), warn before restoring or ignoring them
void set_dirty_behavior (t_dirty val)
 alternative method to modify dirty behavior
void set_overwriting_rules (const crit_action &over)
 overwriting policy
void set_only_deleted (bool val)
 only consider deleted files (if set, no data get restored)
void set_ignore_deleted (bool val)
 do not consider deleted files (if set, no inode will be removed)
void set_fsa_scope (const fsa_scope &scope)
 defines the FSA (Filesystem Specific Attribute) to only consider (by default all FSA activated at compilation time are considered)
const maskget_selection () const
const maskget_subtree () const
bool get_warn_over () const
bool get_info_details () const
bool get_display_treated () const
bool get_display_treated_only_dir () const
bool get_display_skipped () const
const maskget_ea_mask () const
bool get_flat () const
cat_inode::comparison_fields get_what_to_check () const
bool get_warn_remove_no_match () const
bool get_empty () const
bool get_empty_dir () const
t_dirty get_dirty_behavior () const
const crit_actionget_overwriting_rules () const
bool get_only_deleted () const
bool get_ignore_deleted () const
const fsa_scope & get_fsa_scope () const

Detailed Description

class holding optional parameters used to extract files from an existing archive

Definition at line 1028 of file archive_options.hpp.


Member Function Documentation

void libdar::archive_options_extract::set_dirty_behavior ( bool  ignore,
bool  warn 
) [inline]

whether to restore dirty files (those that changed during backup), warn before restoring or ignoring them

Parameters:
[in]ignoreif set to true, dirty files are not restored at all
[in]warnuseless if ignored is false. If warn is true, a warning is issued before restoring each dirty file (default behavior)

Definition at line 1090 of file archive_options.hpp.

void libdar::archive_options_extract::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 1063 of file archive_options.hpp.

do not consider deleted files (if set, no inode will be removed)

Note:
setting both set_only_deleted() and set_ignore_deleted() will not restore anything, almost equivalent to a dry-run execution

Definition at line 1107 of file archive_options.hpp.

void libdar::archive_options_extract::set_info_details ( bool  info_details) [inline]

defines 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 1058 of file archive_options.hpp.

only consider deleted files (if set, no data get restored)

Note:
setting both set_only_deleted() and set_ignore_deleted() will not restore anything, almost equivalent to a dry-run execution

Definition at line 1101 of file archive_options.hpp.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines