Disk ARchive 2.4.2
Public Member Functions
libdar::archive_options_read Class Reference

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

#include <archive_options.hpp>

List of all members.

Public Member Functions

 archive_options_read ()
 build an object and set options to their default values
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_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_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_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)
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
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

Detailed Description

class holding optional parameters used to read an existing archive

Definition at line 60 of file archive_options.hpp.


Member Function Documentation

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
  • %b : the archive basename
  • %p : the slices path
  • %e : the archive extension (usually "dar")
  • %%% : substitued by %%

Definition at line 111 of file archive_options.hpp.

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

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

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

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
  • %b : the archive basename
  • %p : the slices path
  • %e : the archive extension (usually "dar")
  • %%% : substitued by %%

Definition at line 139 of file archive_options.hpp.

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 152 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