Disk ARchive 2.7.14
Full featured and portable backup and archiving tool
Loading...
Searching...
No Matches
Public Member Functions | Private Member Functions | Private Attributes | List of all members
libdar::archive_options_read Class Reference

class holding optional parameters used to read an existing archive More...

#include <archive_options.hpp>

Inherited by libdar5::archive_options_read, and libdar5::archive_options_read.

Public Member Functions

 archive_options_read ()
 build an object and set options to their default values
 
 archive_options_read (const archive_options_read &ref)
 the copy constructor, assignment operator and destructor
 
 archive_options_read (archive_options_read &&ref) noexcept
 
archive_options_readoperator= (const archive_options_read &ref)
 
archive_options_readoperator= (archive_options_read &&ref) noexcept
 
void clear ()
 reset all the options to their default values
 
void set_crypto_algo (crypto_algo val)
 defines the the crypto cypher to use to read the archive (default is crypto_none)
 
void set_crypto_pass (const secu_string &pass)
 defines the password or passphrase to decrypt (unused if encryption is not set)
 
void set_crypto_size (U_32 crypto_size)
 the encryption block size to use to decrypt
 
void set_default_crypto_size ()
 set the encryption block size to the default value
 
void set_input_pipe (const std::string &input_pipe)
 set the name of the input pipe to read data from (when basename is set to "-")
 
void set_output_pipe (const std::string &output_pipe)
 set the name of the output pipe to send orders to (when basenale is set to "-")
 
void set_execute (const std::string &execute)
 set the command to execute before reading each slice (empty string for no script)
 
void set_info_details (bool info_details)
 defines whether the user needs detailed output of the operation
 
void set_lax (bool val)
 defines whether any archive coherence error, system error or media error lead to the abortion of the operation
 
void set_sequential_read (bool val)
 defines whether to try reading the archive sequentially (ala tar) or using the final catalogue
 
void set_slice_min_digits (infinint val)
 defines the minimum digit a slice must have concerning its number, zeros will be prepended as much as necessary to respect this
 
void set_entrepot (const std::shared_ptr< entrepot > &entr)
 defines the protocol to use to retrieve slices
 
void set_ignore_signature_check_failure (bool val)
 whether to warn (true) or ignore (false) signature failure (default is true)
 
void set_multi_threaded (bool val)
 whether libdar is allowed to create several thread to work possibly faster on multicore CPU (need libthreadar to be effective)
 
void set_multi_threaded_crypto (U_I num)
 how much thread libdar will use for cryptography (need libthreadar to be effective)
 
void set_multi_threaded_compress (U_I num)
 how much thread libdar will use for compression (need libthreadar too and compression_block_size > 0)
 
void set_external_catalogue (const path &ref_chem, const std::string &ref_basename)
 defines whether or not to use the catalogue from an extracted catalogue (instead of the one embedded in the archive) and which one to use
 
void unset_external_catalogue ()
 clear any reference to an external catalogue
 
void set_ref_crypto_algo (crypto_algo ref_crypto)
 defines the crypto algo for the reference catalogue
 
void set_ref_crypto_pass (const secu_string &ref_pass)
 defines the pass for the reference catalogue
 
void set_ref_crypto_size (U_32 ref_crypto_size)
 defines the crypto size for the reference catalogue
 
void set_ref_execute (const std::string &ref_execute)
 set the command to execute before reading each slice of the reference catalogue
 
void set_ref_slice_min_digits (infinint val)
 defines the minim digit for slice number of the archive of reference (where the external catalogue is read from)
 
void set_ref_entrepot (const std::shared_ptr< entrepot > &entr)
 defines the protocol to use to retrieve slices of the reference archive (where the external catalogue resides)
 
void set_header_only (bool val)
 whether we only read the archive header and exit
 
crypto_algo get_crypto_algo () const
 
const secu_stringget_crypto_pass () const
 
U_32 get_crypto_size () const
 
const std::string & get_input_pipe () const
 
const std::string & get_output_pipe () const
 
const std::string & get_execute () const
 
bool get_info_details () const
 
bool get_lax () const
 
bool get_sequential_read () const
 
infinint get_slice_min_digits () const
 
const std::shared_ptr< entrepot > & get_entrepot () const
 
bool get_ignore_signature_check_failure () const
 
U_I get_multi_threaded_crypto () const
 
U_I get_multi_threaded_compress () const
 
bool is_external_catalogue_set () const
 
const pathget_ref_path () const
 
const std::string & get_ref_basename () const
 
crypto_algo get_ref_crypto_algo () const
 
const secu_stringget_ref_crypto_pass () const
 
U_32 get_ref_crypto_size () const
 
const std::string & get_ref_execute () const
 
infinint get_ref_slice_min_digits () const
 
const std::shared_ptr< entrepot > & get_ref_entrepot () const
 
bool get_header_only () const
 
 archive_options_read ()
 build an object and set options to their default values
 
 archive_options_read (const archive_options_read &ref)
 the copy constructor, assignment operator and destructor
 
 archive_options_read (archive_options_read &&ref) noexcept
 
archive_options_readoperator= (const archive_options_read &ref)
 
archive_options_readoperator= (archive_options_read &&ref) noexcept
 
void clear ()
 reset all the options to their default values
 
void set_crypto_algo (crypto_algo val)
 defines the the crypto cypher to use to read the archive (default is crypto_none)
 
void set_crypto_pass (const secu_string &pass)
 defines the password or passphrase to decrypt (unused if encryption is not set)
 
void set_crypto_size (U_32 crypto_size)
 the encryption block size to use to decrypt
 
void set_default_crypto_size ()
 set the encryption block size to the default value
 
void set_input_pipe (const std::string &input_pipe)
 set the name of the input pipe to read data from (when basename is set to "-")
 
void set_output_pipe (const std::string &output_pipe)
 set the name of the output pipe to send orders to (when basenale is set to "-")
 
void set_execute (const std::string &execute)
 set the command to execute before reading each slice (empty string for no script)
 
void set_info_details (bool info_details)
 defines whether the user needs detailed output of the operation
 
void set_lax (bool val)
 defines whether any archive coherence error, system error or media error lead to the abortion of the operation
 
void set_sequential_read (bool val)
 defines whether to try reading the archive sequentially (ala tar) or using the final catalogue
 
void set_slice_min_digits (infinint val)
 defines the minimum digit a slice must have concerning its number, zeros will be prepended as much as necessary to respect this
 
void set_entrepot (const std::shared_ptr< entrepot > &entr)
 defines the protocol to use to retrieve slices
 
void set_ignore_signature_check_failure (bool val)
 whether to warn (true) or ignore (false) signature failure (default is true)
 
void set_multi_threaded (bool val)
 whether libdar is allowed to create several thread to work possibly faster on multicore CPU (need libthreadar to be effective)
 
void set_multi_threaded_crypto (U_I num)
 how much thread libdar will use for cryptography (need libthreadar to be effective)
 
void set_multi_threaded_compress (U_I num)
 how much thread libdar will use for compression (need libthreadar too and compression_block_size > 0)
 
void set_external_catalogue (const path &ref_chem, const std::string &ref_basename)
 defines whether or not to use the catalogue from an extracted catalogue (instead of the one embedded in the archive) and which one to use
 
void unset_external_catalogue ()
 clear any reference to an external catalogue
 
void set_ref_crypto_algo (crypto_algo ref_crypto)
 defines the crypto algo for the reference catalogue
 
void set_ref_crypto_pass (const secu_string &ref_pass)
 defines the pass for the reference catalogue
 
void set_ref_crypto_size (U_32 ref_crypto_size)
 defines the crypto size for the reference catalogue
 
void set_ref_execute (const std::string &ref_execute)
 set the command to execute before reading each slice of the reference catalogue
 
void set_ref_slice_min_digits (infinint val)
 defines the minim digit for slice number of the archive of reference (where the external catalogue is read from)
 
void set_ref_entrepot (const std::shared_ptr< entrepot > &entr)
 defines the protocol to use to retrieve slices of the reference archive (where the external catalogue resides)
 
void set_header_only (bool val)
 whether we only read the archive header and exit
 
crypto_algo get_crypto_algo () const
 
const secu_stringget_crypto_pass () const
 
U_32 get_crypto_size () const
 
const std::string & get_input_pipe () const
 
const std::string & get_output_pipe () const
 
const std::string & get_execute () const
 
bool get_info_details () const
 
bool get_lax () const
 
bool get_sequential_read () const
 
infinint get_slice_min_digits () const
 
const std::shared_ptr< entrepot > & get_entrepot () const
 
bool get_ignore_signature_check_failure () const
 
U_I get_multi_threaded_crypto () const
 
U_I get_multi_threaded_compress () const
 
bool is_external_catalogue_set () const
 
const pathget_ref_path () const
 
const std::string & get_ref_basename () const
 
crypto_algo get_ref_crypto_algo () const
 
const secu_stringget_ref_crypto_pass () const
 
U_32 get_ref_crypto_size () const
 
const std::string & get_ref_execute () const
 
infinint get_ref_slice_min_digits () const
 
const std::shared_ptr< entrepot > & get_ref_entrepot () const
 
bool get_header_only () const
 

Private Member Functions

void copy_from (const archive_options_read &ref)
 
void move_from (archive_options_read &&ref) noexcept
 
void copy_from (const archive_options_read &ref)
 
void move_from (archive_options_read &&ref) noexcept
 

Private Attributes

crypto_algo x_crypto
 
secu_string x_pass
 
U_32 x_crypto_size
 
std::string x_input_pipe
 
std::string x_output_pipe
 
std::string x_execute
 
bool x_info_details
 
bool x_lax
 
bool x_sequential_read
 
infinint x_slice_min_digits
 
std::shared_ptr< entrepotx_entrepot
 
bool x_ignore_signature_check_failure
 
U_I x_multi_threaded_crypto
 
U_I x_multi_threaded_compress
 
bool external_cat
 
path x_ref_chem
 
std::string x_ref_basename
 
crypto_algo x_ref_crypto
 
secu_string x_ref_pass
 
U_32 x_ref_crypto_size
 
std::string x_ref_execute
 
infinint x_ref_slice_min_digits
 
std::shared_ptr< entrepotx_ref_entrepot
 
bool x_header_only
 

Detailed Description

class holding optional parameters used to read an existing archive

Definition at line 64 of file dar64-2.7.14-win64/include/dar/archive_options.hpp.

Constructor & Destructor Documentation

◆ archive_options_read() [1/2]

libdar::archive_options_read::archive_options_read ( const archive_options_read & ref)
inline

the copy constructor, assignment operator and destructor

Definition at line 71 of file dar64-2.7.14-win64/include/dar/archive_options.hpp.

◆ archive_options_read() [2/2]

libdar::archive_options_read::archive_options_read ( const archive_options_read & ref)
inline

the copy constructor, assignment operator and destructor

Definition at line 71 of file src/libdar/archive_options.hpp.

Member Function Documentation

◆ get_crypto_algo() [1/2]

crypto_algo libdar::archive_options_read::get_crypto_algo ( ) const
inline

◆ get_crypto_algo() [2/2]

crypto_algo libdar::archive_options_read::get_crypto_algo ( ) const
inline

Definition at line 219 of file src/libdar/archive_options.hpp.

◆ get_crypto_pass() [1/2]

const secu_string & libdar::archive_options_read::get_crypto_pass ( ) const
inline

◆ get_crypto_pass() [2/2]

const secu_string & libdar::archive_options_read::get_crypto_pass ( ) const
inline

Definition at line 220 of file src/libdar/archive_options.hpp.

◆ get_crypto_size() [1/2]

U_32 libdar::archive_options_read::get_crypto_size ( ) const
inline

◆ get_crypto_size() [2/2]

U_32 libdar::archive_options_read::get_crypto_size ( ) const
inline

Definition at line 221 of file src/libdar/archive_options.hpp.

◆ get_entrepot() [1/2]

const std::shared_ptr< entrepot > & libdar::archive_options_read::get_entrepot ( ) const
inline

◆ get_entrepot() [2/2]

const std::shared_ptr< entrepot > & libdar::archive_options_read::get_entrepot ( ) const
inline

Definition at line 229 of file src/libdar/archive_options.hpp.

◆ get_execute() [1/2]

const std::string & libdar::archive_options_read::get_execute ( ) const
inline

◆ get_execute() [2/2]

const std::string & libdar::archive_options_read::get_execute ( ) const
inline

Definition at line 224 of file src/libdar/archive_options.hpp.

◆ get_header_only() [1/2]

bool libdar::archive_options_read::get_header_only ( ) const
inline

◆ get_header_only() [2/2]

bool libdar::archive_options_read::get_header_only ( ) const
inline

Definition at line 244 of file src/libdar/archive_options.hpp.

◆ get_ignore_signature_check_failure() [1/2]

bool libdar::archive_options_read::get_ignore_signature_check_failure ( ) const
inline

◆ get_ignore_signature_check_failure() [2/2]

bool libdar::archive_options_read::get_ignore_signature_check_failure ( ) const
inline

Definition at line 230 of file src/libdar/archive_options.hpp.

◆ get_info_details() [1/2]

bool libdar::archive_options_read::get_info_details ( ) const
inline

◆ get_info_details() [2/2]

bool libdar::archive_options_read::get_info_details ( ) const
inline

Definition at line 225 of file src/libdar/archive_options.hpp.

◆ get_input_pipe() [1/2]

const std::string & libdar::archive_options_read::get_input_pipe ( ) const
inline

◆ get_input_pipe() [2/2]

const std::string & libdar::archive_options_read::get_input_pipe ( ) const
inline

Definition at line 222 of file src/libdar/archive_options.hpp.

◆ get_lax() [1/2]

bool libdar::archive_options_read::get_lax ( ) const
inline

◆ get_lax() [2/2]

bool libdar::archive_options_read::get_lax ( ) const
inline

Definition at line 226 of file src/libdar/archive_options.hpp.

◆ get_multi_threaded_compress() [1/2]

U_I libdar::archive_options_read::get_multi_threaded_compress ( ) const
inline

◆ get_multi_threaded_compress() [2/2]

U_I libdar::archive_options_read::get_multi_threaded_compress ( ) const
inline

Definition at line 232 of file src/libdar/archive_options.hpp.

◆ get_multi_threaded_crypto() [1/2]

U_I libdar::archive_options_read::get_multi_threaded_crypto ( ) const
inline

◆ get_multi_threaded_crypto() [2/2]

U_I libdar::archive_options_read::get_multi_threaded_crypto ( ) const
inline

Definition at line 231 of file src/libdar/archive_options.hpp.

◆ get_output_pipe() [1/2]

const std::string & libdar::archive_options_read::get_output_pipe ( ) const
inline

◆ get_output_pipe() [2/2]

const std::string & libdar::archive_options_read::get_output_pipe ( ) const
inline

Definition at line 223 of file src/libdar/archive_options.hpp.

◆ get_ref_crypto_algo() [1/2]

crypto_algo libdar::archive_options_read::get_ref_crypto_algo ( ) const
inline

◆ get_ref_crypto_algo() [2/2]

crypto_algo libdar::archive_options_read::get_ref_crypto_algo ( ) const
inline

Definition at line 238 of file src/libdar/archive_options.hpp.

◆ get_ref_crypto_pass() [1/2]

const secu_string & libdar::archive_options_read::get_ref_crypto_pass ( ) const
inline

◆ get_ref_crypto_pass() [2/2]

const secu_string & libdar::archive_options_read::get_ref_crypto_pass ( ) const
inline

Definition at line 239 of file src/libdar/archive_options.hpp.

◆ get_ref_crypto_size() [1/2]

U_32 libdar::archive_options_read::get_ref_crypto_size ( ) const
inline

◆ get_ref_crypto_size() [2/2]

U_32 libdar::archive_options_read::get_ref_crypto_size ( ) const
inline

Definition at line 240 of file src/libdar/archive_options.hpp.

◆ get_ref_entrepot() [1/2]

const std::shared_ptr< entrepot > & libdar::archive_options_read::get_ref_entrepot ( ) const
inline

◆ get_ref_entrepot() [2/2]

const std::shared_ptr< entrepot > & libdar::archive_options_read::get_ref_entrepot ( ) const
inline

Definition at line 243 of file src/libdar/archive_options.hpp.

◆ get_ref_execute() [1/2]

const std::string & libdar::archive_options_read::get_ref_execute ( ) const
inline

◆ get_ref_execute() [2/2]

const std::string & libdar::archive_options_read::get_ref_execute ( ) const
inline

Definition at line 241 of file src/libdar/archive_options.hpp.

◆ get_ref_slice_min_digits() [1/2]

infinint libdar::archive_options_read::get_ref_slice_min_digits ( ) const
inline

◆ get_ref_slice_min_digits() [2/2]

infinint libdar::archive_options_read::get_ref_slice_min_digits ( ) const
inline

Definition at line 242 of file src/libdar/archive_options.hpp.

◆ get_sequential_read() [1/2]

bool libdar::archive_options_read::get_sequential_read ( ) const
inline

◆ get_sequential_read() [2/2]

bool libdar::archive_options_read::get_sequential_read ( ) const
inline

Definition at line 227 of file src/libdar/archive_options.hpp.

◆ get_slice_min_digits() [1/2]

infinint libdar::archive_options_read::get_slice_min_digits ( ) const
inline

◆ get_slice_min_digits() [2/2]

infinint libdar::archive_options_read::get_slice_min_digits ( ) const
inline

Definition at line 228 of file src/libdar/archive_options.hpp.

◆ is_external_catalogue_set() [1/2]

bool libdar::archive_options_read::is_external_catalogue_set ( ) const
inline

◆ is_external_catalogue_set() [2/2]

bool libdar::archive_options_read::is_external_catalogue_set ( ) const
inline

Definition at line 235 of file src/libdar/archive_options.hpp.

◆ operator=() [1/4]

archive_options_read & libdar::archive_options_read::operator= ( archive_options_read && ref)
inlinenoexcept

◆ operator=() [2/4]

archive_options_read & libdar::archive_options_read::operator= ( archive_options_read && ref)
inlinenoexcept

Definition at line 74 of file src/libdar/archive_options.hpp.

◆ operator=() [3/4]

archive_options_read & libdar::archive_options_read::operator= ( const archive_options_read & ref)
inline

◆ operator=() [4/4]

archive_options_read & libdar::archive_options_read::operator= ( const archive_options_read & ref)
inline

Definition at line 73 of file src/libdar/archive_options.hpp.

◆ set_crypto_algo() [1/2]

void libdar::archive_options_read::set_crypto_algo ( crypto_algo val)
inline

defines the the crypto cypher to use to read the archive (default is crypto_none)

Note
since release 2.5.0 you may and should provide crypto_none in any case (the default value) for libdar uses the algorithm stored in the archive. However you way override this (in case of corruption for example) by explicitely specifying a crypto algorithm in that case the value of the crypto algorithm stored in the archive is ignored and the algorithm used to decipher is the one specified here.

Definition at line 97 of file dar64-2.7.14-win64/include/dar/archive_options.hpp.

◆ set_crypto_algo() [2/2]

void libdar::archive_options_read::set_crypto_algo ( crypto_algo val)
inline

defines the the crypto cypher to use to read the archive (default is crypto_none)

Note
since release 2.5.0 you may and should provide crypto_none in any case (the default value) for libdar uses the algorithm stored in the archive. However you way override this (in case of corruption for example) by explicitely specifying a crypto algorithm in that case the value of the crypto algorithm stored in the archive is ignored and the algorithm used to decipher is the one specified here.

Definition at line 97 of file src/libdar/archive_options.hpp.

◆ set_crypto_pass() [1/2]

void libdar::archive_options_read::set_crypto_pass ( const secu_string & pass)
inline

defines the password or passphrase to decrypt (unused if encryption is not set)

Definition at line 100 of file dar64-2.7.14-win64/include/dar/archive_options.hpp.

◆ set_crypto_pass() [2/2]

void libdar::archive_options_read::set_crypto_pass ( const secu_string & pass)
inline

defines the password or passphrase to decrypt (unused if encryption is not set)

Definition at line 100 of file src/libdar/archive_options.hpp.

◆ set_crypto_size() [1/2]

void libdar::archive_options_read::set_crypto_size ( U_32 crypto_size)
inline

the encryption block size to use to decrypt

Definition at line 103 of file dar64-2.7.14-win64/include/dar/archive_options.hpp.

◆ set_crypto_size() [2/2]

void libdar::archive_options_read::set_crypto_size ( U_32 crypto_size)
inline

the encryption block size to use to decrypt

Definition at line 103 of file src/libdar/archive_options.hpp.

◆ set_entrepot() [1/2]

void libdar::archive_options_read::set_entrepot ( const std::shared_ptr< entrepot > & entr)
inline

defines the protocol to use to retrieve slices

Definition at line 155 of file dar64-2.7.14-win64/include/dar/archive_options.hpp.

◆ set_entrepot() [2/2]

void libdar::archive_options_read::set_entrepot ( const std::shared_ptr< entrepot > & entr)
inline

defines the protocol to use to retrieve slices

Definition at line 155 of file src/libdar/archive_options.hpp.

◆ set_execute() [1/2]

void libdar::archive_options_read::set_execute ( const std::string & execute)
inline

set the command to execute before reading each slice (empty string for no script)

several macros are available:

  • %n : the slice number to be read
  • %N : the slice number with padded zeros according to slice_min_digits given option
  • %b : the archive basename
  • %p : the slices path
  • %e : the archive extension (usually "dar")
  • %c : the archive context ("init", "operation" or "last_slice") see dar(1) man page for more details
  • %%% : substitued by %%

Definition at line 131 of file dar64-2.7.14-win64/include/dar/archive_options.hpp.

◆ set_execute() [2/2]

void libdar::archive_options_read::set_execute ( const std::string & execute)
inline

set the command to execute before reading each slice (empty string for no script)

several macros are available:

  • %n : the slice number to be read
  • %N : the slice number with padded zeros according to slice_min_digits given option
  • %b : the archive basename
  • %p : the slices path
  • %e : the archive extension (usually "dar")
  • %c : the archive context ("init", "operation" or "last_slice") see dar(1) man page for more details
  • %%% : substitued by %%

Definition at line 131 of file src/libdar/archive_options.hpp.

◆ set_external_catalogue() [1/2]

void libdar::archive_options_read::set_external_catalogue ( const path & ref_chem,
const std::string & ref_basename )
inline

defines whether or not to use the catalogue from an extracted catalogue (instead of the one embedded in the archive) and which one to use

Definition at line 176 of file dar64-2.7.14-win64/include/dar/archive_options.hpp.

◆ set_external_catalogue() [2/2]

void libdar::archive_options_read::set_external_catalogue ( const path & ref_chem,
const std::string & ref_basename )
inline

defines whether or not to use the catalogue from an extracted catalogue (instead of the one embedded in the archive) and which one to use

Definition at line 176 of file src/libdar/archive_options.hpp.

◆ set_header_only() [1/2]

void libdar::archive_options_read::set_header_only ( bool val)
inline

whether we only read the archive header and exit

Definition at line 211 of file dar64-2.7.14-win64/include/dar/archive_options.hpp.

◆ set_header_only() [2/2]

void libdar::archive_options_read::set_header_only ( bool val)
inline

whether we only read the archive header and exit

Definition at line 211 of file src/libdar/archive_options.hpp.

◆ set_ignore_signature_check_failure() [1/2]

void libdar::archive_options_read::set_ignore_signature_check_failure ( bool val)
inline

whether to warn (true) or ignore (false) signature failure (default is true)

Definition at line 158 of file dar64-2.7.14-win64/include/dar/archive_options.hpp.

◆ set_ignore_signature_check_failure() [2/2]

void libdar::archive_options_read::set_ignore_signature_check_failure ( bool val)
inline

whether to warn (true) or ignore (false) signature failure (default is true)

Definition at line 158 of file src/libdar/archive_options.hpp.

◆ set_info_details() [1/2]

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

defines whether the user needs detailed output of the operation

Definition at line 134 of file dar64-2.7.14-win64/include/dar/archive_options.hpp.

◆ set_info_details() [2/2]

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

defines whether the user needs detailed output of the operation

Definition at line 134 of file src/libdar/archive_options.hpp.

◆ set_input_pipe() [1/2]

void libdar::archive_options_read::set_input_pipe ( const std::string & input_pipe)
inline

set the name of the input pipe to read data from (when basename is set to "-")

if input_pipe is set to "" (empty string) the information from dar_slave are expected in standard input else the given string

Definition at line 112 of file dar64-2.7.14-win64/include/dar/archive_options.hpp.

◆ set_input_pipe() [2/2]

void libdar::archive_options_read::set_input_pipe ( const std::string & input_pipe)
inline

set the name of the input pipe to read data from (when basename is set to "-")

if input_pipe is set to "" (empty string) the information from dar_slave are expected in standard input else the given string

Definition at line 112 of file src/libdar/archive_options.hpp.

◆ set_lax() [1/2]

void libdar::archive_options_read::set_lax ( bool val)
inline

defines whether any archive coherence error, system error or media error lead to the abortion of the operation

lax mode is false by default. setting it to true, may allow more data to be restored, but may lead the user to get corrupted data the user will be warned and asked upon what to do if such case arrives.

Definition at line 141 of file dar64-2.7.14-win64/include/dar/archive_options.hpp.

◆ set_lax() [2/2]

void libdar::archive_options_read::set_lax ( bool val)
inline

defines whether any archive coherence error, system error or media error lead to the abortion of the operation

lax mode is false by default. setting it to true, may allow more data to be restored, but may lead the user to get corrupted data the user will be warned and asked upon what to do if such case arrives.

Definition at line 141 of file src/libdar/archive_options.hpp.

◆ set_multi_threaded() [1/2]

void libdar::archive_options_read::set_multi_threaded ( bool val)
inline

whether libdar is allowed to create several thread to work possibly faster on multicore CPU (need libthreadar to be effective)

Deprecated
this call is deprecated, see set_multi_threaded_*() more specific calls
Note
setting this to true is equivalent to calling set_mutli_threaded_crypto(2)

Definition at line 164 of file dar64-2.7.14-win64/include/dar/archive_options.hpp.

◆ set_multi_threaded() [2/2]

void libdar::archive_options_read::set_multi_threaded ( bool val)
inline

whether libdar is allowed to create several thread to work possibly faster on multicore CPU (need libthreadar to be effective)

Deprecated
this call is deprecated, see set_multi_threaded_*() more specific calls
Note
setting this to true is equivalent to calling set_mutli_threaded_crypto(2)

Definition at line 164 of file src/libdar/archive_options.hpp.

◆ set_multi_threaded_compress() [1/2]

void libdar::archive_options_read::set_multi_threaded_compress ( U_I num)
inline

how much thread libdar will use for compression (need libthreadar too and compression_block_size > 0)

Definition at line 170 of file dar64-2.7.14-win64/include/dar/archive_options.hpp.

◆ set_multi_threaded_compress() [2/2]

void libdar::archive_options_read::set_multi_threaded_compress ( U_I num)
inline

how much thread libdar will use for compression (need libthreadar too and compression_block_size > 0)

Definition at line 170 of file src/libdar/archive_options.hpp.

◆ set_multi_threaded_crypto() [1/2]

void libdar::archive_options_read::set_multi_threaded_crypto ( U_I num)
inline

how much thread libdar will use for cryptography (need libthreadar to be effective)

Definition at line 167 of file dar64-2.7.14-win64/include/dar/archive_options.hpp.

◆ set_multi_threaded_crypto() [2/2]

void libdar::archive_options_read::set_multi_threaded_crypto ( U_I num)
inline

how much thread libdar will use for cryptography (need libthreadar to be effective)

Definition at line 167 of file src/libdar/archive_options.hpp.

◆ set_output_pipe() [1/2]

void libdar::archive_options_read::set_output_pipe ( const std::string & output_pipe)
inline

set the name of the output pipe to send orders to (when basenale is set to "-")

if output_pipe is set to "" the orders sent to dar_slave will exit by the standard output else the given string must be the path to a named pipe which will relay the orders to dar_slave

Definition at line 118 of file dar64-2.7.14-win64/include/dar/archive_options.hpp.

◆ set_output_pipe() [2/2]

void libdar::archive_options_read::set_output_pipe ( const std::string & output_pipe)
inline

set the name of the output pipe to send orders to (when basenale is set to "-")

if output_pipe is set to "" the orders sent to dar_slave will exit by the standard output else the given string must be the path to a named pipe which will relay the orders to dar_slave

Definition at line 118 of file src/libdar/archive_options.hpp.

◆ set_ref_crypto_algo() [1/2]

void libdar::archive_options_read::set_ref_crypto_algo ( crypto_algo ref_crypto)
inline

defines the crypto algo for the reference catalogue

Definition at line 181 of file dar64-2.7.14-win64/include/dar/archive_options.hpp.

◆ set_ref_crypto_algo() [2/2]

void libdar::archive_options_read::set_ref_crypto_algo ( crypto_algo ref_crypto)
inline

defines the crypto algo for the reference catalogue

Definition at line 181 of file src/libdar/archive_options.hpp.

◆ set_ref_crypto_pass() [1/2]

void libdar::archive_options_read::set_ref_crypto_pass ( const secu_string & ref_pass)
inline

defines the pass for the reference catalogue

Definition at line 184 of file dar64-2.7.14-win64/include/dar/archive_options.hpp.

◆ set_ref_crypto_pass() [2/2]

void libdar::archive_options_read::set_ref_crypto_pass ( const secu_string & ref_pass)
inline

defines the pass for the reference catalogue

Definition at line 184 of file src/libdar/archive_options.hpp.

◆ set_ref_crypto_size() [1/2]

void libdar::archive_options_read::set_ref_crypto_size ( U_32 ref_crypto_size)
inline

defines the crypto size for the reference catalogue

Definition at line 187 of file dar64-2.7.14-win64/include/dar/archive_options.hpp.

◆ set_ref_crypto_size() [2/2]

void libdar::archive_options_read::set_ref_crypto_size ( U_32 ref_crypto_size)
inline

defines the crypto size for the reference catalogue

Definition at line 187 of file src/libdar/archive_options.hpp.

◆ set_ref_entrepot() [1/2]

void libdar::archive_options_read::set_ref_entrepot ( const std::shared_ptr< entrepot > & entr)
inline

defines the protocol to use to retrieve slices of the reference archive (where the external catalogue resides)

Definition at line 208 of file dar64-2.7.14-win64/include/dar/archive_options.hpp.

◆ set_ref_entrepot() [2/2]

void libdar::archive_options_read::set_ref_entrepot ( const std::shared_ptr< entrepot > & entr)
inline

defines the protocol to use to retrieve slices of the reference archive (where the external catalogue resides)

Definition at line 208 of file src/libdar/archive_options.hpp.

◆ set_ref_execute() [1/2]

void libdar::archive_options_read::set_ref_execute ( const std::string & ref_execute)
inline

set the command to execute before reading each slice of the reference catalogue

several macros are available:

  • %n : the slice number to be read
  • %N : the slice number with padded zeros according to slice_min_digits given option
  • %b : the archive basename
  • %p : the slices path
  • %e : the archive extension (usually "dar")
  • %c : the archive context ("init", "operation" or "last_slice") see dar(1) man page for more details
  • %%% : substitued by %%

Definition at line 200 of file dar64-2.7.14-win64/include/dar/archive_options.hpp.

◆ set_ref_execute() [2/2]

void libdar::archive_options_read::set_ref_execute ( const std::string & ref_execute)
inline

set the command to execute before reading each slice of the reference catalogue

several macros are available:

  • %n : the slice number to be read
  • %N : the slice number with padded zeros according to slice_min_digits given option
  • %b : the archive basename
  • %p : the slices path
  • %e : the archive extension (usually "dar")
  • %c : the archive context ("init", "operation" or "last_slice") see dar(1) man page for more details
  • %%% : substitued by %%

Definition at line 200 of file src/libdar/archive_options.hpp.

◆ set_ref_slice_min_digits() [1/2]

void libdar::archive_options_read::set_ref_slice_min_digits ( infinint val)
inline

defines the minim digit for slice number of the archive of reference (where the external catalogue is read from)

Definition at line 205 of file dar64-2.7.14-win64/include/dar/archive_options.hpp.

◆ set_ref_slice_min_digits() [2/2]

void libdar::archive_options_read::set_ref_slice_min_digits ( infinint val)
inline

defines the minim digit for slice number of the archive of reference (where the external catalogue is read from)

Definition at line 205 of file src/libdar/archive_options.hpp.

◆ set_sequential_read() [1/2]

void libdar::archive_options_read::set_sequential_read ( bool val)
inline

defines whether to try reading the archive sequentially (ala tar) or using the final catalogue

the sequential reading must not has been disabled at creation time and the archive must be of minimum format "08" for the operation not to fail

Definition at line 147 of file dar64-2.7.14-win64/include/dar/archive_options.hpp.

◆ set_sequential_read() [2/2]

void libdar::archive_options_read::set_sequential_read ( bool val)
inline

defines whether to try reading the archive sequentially (ala tar) or using the final catalogue

the sequential reading must not has been disabled at creation time and the archive must be of minimum format "08" for the operation not to fail

Definition at line 147 of file src/libdar/archive_options.hpp.

◆ set_slice_min_digits() [1/2]

void libdar::archive_options_read::set_slice_min_digits ( infinint val)
inline

defines the minimum digit a slice must have concerning its number, zeros will be prepended as much as necessary to respect this

Definition at line 151 of file dar64-2.7.14-win64/include/dar/archive_options.hpp.

◆ set_slice_min_digits() [2/2]

void libdar::archive_options_read::set_slice_min_digits ( infinint val)
inline

defines the minimum digit a slice must have concerning its number, zeros will be prepended as much as necessary to respect this

Definition at line 151 of file src/libdar/archive_options.hpp.

Member Data Documentation

◆ external_cat

bool libdar::archive_options_read::external_cat
private

◆ x_crypto

crypto_algo libdar::archive_options_read::x_crypto
private

◆ x_crypto_size

U_32 libdar::archive_options_read::x_crypto_size
private

◆ x_entrepot

std::shared_ptr< entrepot > libdar::archive_options_read::x_entrepot
private

◆ x_execute

std::string libdar::archive_options_read::x_execute
private

◆ x_header_only

bool libdar::archive_options_read::x_header_only
private

◆ x_ignore_signature_check_failure

bool libdar::archive_options_read::x_ignore_signature_check_failure
private

◆ x_info_details

bool libdar::archive_options_read::x_info_details
private

◆ x_input_pipe

std::string libdar::archive_options_read::x_input_pipe
private

◆ x_lax

bool libdar::archive_options_read::x_lax
private

◆ x_multi_threaded_compress

U_I libdar::archive_options_read::x_multi_threaded_compress
private

◆ x_multi_threaded_crypto

U_I libdar::archive_options_read::x_multi_threaded_crypto
private

◆ x_output_pipe

std::string libdar::archive_options_read::x_output_pipe
private

◆ x_pass

secu_string libdar::archive_options_read::x_pass
private

◆ x_ref_basename

std::string libdar::archive_options_read::x_ref_basename
private

◆ x_ref_chem

path libdar::archive_options_read::x_ref_chem
private

◆ x_ref_crypto

crypto_algo libdar::archive_options_read::x_ref_crypto
private

◆ x_ref_crypto_size

U_32 libdar::archive_options_read::x_ref_crypto_size
private

◆ x_ref_entrepot

std::shared_ptr< entrepot > libdar::archive_options_read::x_ref_entrepot
private

◆ x_ref_execute

std::string libdar::archive_options_read::x_ref_execute
private

◆ x_ref_pass

secu_string libdar::archive_options_read::x_ref_pass
private

◆ x_ref_slice_min_digits

infinint libdar::archive_options_read::x_ref_slice_min_digits
private

◆ x_sequential_read

bool libdar::archive_options_read::x_sequential_read
private

◆ x_slice_min_digits

infinint libdar::archive_options_read::x_slice_min_digits
private

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