Disk ARchive  2.7.15
Full featured and portable backup and archiving tool
archive_summary.hpp
Go to the documentation of this file.
1 /*********************************************************************/
2 // dar - disk archive - a backup/restoration program
3 // Copyright (C) 2002-2024 Denis Corbin
4 //
5 // This program is free software; you can redistribute it and/or
6 // modify it under the terms of the GNU General Public License
7 // as published by the Free Software Foundation; either version 2
8 // of the License, or (at your option) any later version.
9 //
10 // This program is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with this program; if not, write to the Free Software
17 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18 //
19 // to contact the author, see the AUTHOR file
20 /*********************************************************************/
21 
25 
26 
27 #ifndef ARCHIVE_SUMMARY_HPP
28 #define ARCHIVE_SUMMARY_HPP
29 
30 #include "../my_config.h"
31 #include <string>
32 #include "infinint.hpp"
33 #include "entree_stats.hpp"
34 
35 namespace libdar
36 {
37 
40 
41 
43 
45  {
46  public:
47  archive_summary() { clear(); };
48  archive_summary(const archive_summary & ref) = default;
49  archive_summary(archive_summary && ref) noexcept = default;
50  archive_summary & operator = (const archive_summary & ref) = default;
51  archive_summary & operator = (archive_summary && ref) noexcept = default;
52  ~archive_summary() = default;
53 
54  // GETTINGS
55 
56  const infinint & get_slice_size() const { return slice_size; };
57  const infinint & get_first_slice_size() const { return first_slice_size; };
58  const infinint & get_last_slice_size() const { return last_slice_size; };
59  const infinint & get_ref_slice_size() const { return ref_slice_size; };
60  const infinint & get_ref_first_slice_size() const { return ref_first_slice_size; };
61  const infinint & get_slice_number() const { return slice_number; };
62  const infinint & get_archive_size() const { return archive_size; };
63  const infinint & get_catalog_size() const { return catalog_size; };
64  const infinint & get_storage_size() const { return storage_size; };
65  const infinint & get_data_size() const { return data_size; };
66  const entree_stats & get_contents() const { return contents; };
67  std::string get_edition() const { return edition; };
68  std::string get_compression_algo() const { return algo_zip; };
69  std::string get_user_comment() const { return user_comment; };
70  std::string get_cipher() const { return cipher; };
71  std::string get_asym() const { return asym; };
72  bool get_signed() const { return is_signed; };
73  bool get_tape_marks() const { return tape_marks; };
74  std::string get_in_place() const { return in_place; };
75 
76 
77  // SETTINGS
78 
79  void set_slice_size(const infinint & arg) { slice_size = arg; };
80  void set_first_slice_size(const infinint & arg) { first_slice_size = arg; };
81  void set_last_slice_size(const infinint & arg) { last_slice_size = arg; };
82  void set_ref_slice_size(const infinint & arg) { ref_slice_size = arg; };
83  void set_ref_first_slice_size(const infinint & arg) { ref_first_slice_size = arg; };
84  void set_slice_number(const infinint & arg) { slice_number = arg; };
85  void set_archive_size(const infinint & arg) { archive_size = arg; };
86  void set_catalog_size(const infinint & arg) { catalog_size = arg; };
87  void set_storage_size(const infinint & arg) { storage_size = arg; };
88  void set_data_size(const infinint & arg) { data_size = arg; };
89  void set_contents(const entree_stats & arg) { contents = arg; };
90  void set_edition(const std::string & arg) { edition = arg; };
91  void set_compression_algo(const std::string & arg) { algo_zip = arg; };
92  void set_user_comment(const std::string & arg) { user_comment = arg; };
93  void set_cipher(const std::string & arg) { cipher = arg; };
94  void set_asym(const std::string & arg) { asym = arg; };
95  void set_signed(bool arg) { is_signed = arg; };
96  void set_tape_marks(bool arg) { tape_marks = arg; };
97  void set_in_place(const std::string & arg) { in_place = arg; };
98 
99  void clear();
100 
101  private:
113  std::string edition;
114  std::string algo_zip;
115  std::string user_comment;
116  std::string cipher;
117  std::string asym;
118  bool is_signed;
119  bool tape_marks;
120  std::string in_place;
121 
122  };
123 
124 } // end of namespace
125 
126 #endif
the archive_summary class provides information about a given archive
the arbitrary large positive integer class
datastructure holding the nature of file present in a given archive
bool is_signed
whether the archive is signed
std::string edition
archive format
infinint archive_size
total size of the archive
infinint slice_size
slice of the middle slice or zero if not applicable
infinint last_slice_size
slice of the last slice or zero if not applicable
std::string user_comment
user comment
std::string in_place
in_place path empty string if absent
infinint ref_first_slice_size
slice of the first slice of the archive of reference
entree_stats contents
nature of saved files
bool tape_marks
whether the archive has tape marks (for sequential reading)
infinint storage_size
amount of byte used to store (compressed/encrypted) data
infinint slice_number
number of slices composing the archive of zero if unknown
std::string cipher
encryption algorithm
infinint data_size
amount of data saved (once uncompressed/unciphered)
infinint ref_slice_size
slice of the slice of the archive of reference
std::string algo_zip
compression algorithm
infinint catalog_size
catalogue size if known, zero if not
infinint first_slice_size
slice of the first slices or zero if not applicable
std::string asym
asymetrical encryption
switch module to limitint (32 ou 64 bits integers) or infinint
libdar namespace encapsulate all libdar symbols
Definition: archive.hpp:47
holds the statistics contents of a catalogue