Loading...
Searching...
No Matches
archive_summary.hpp
Go to the documentation of this file.
/*********************************************************************/
// dar - disk archive - a backup/restoration program
// Copyright (C) 2002-2026 Denis Corbin
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License
// as published by the Free Software Foundation; either version 2
// of the License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
//
// to contact the author, see the AUTHOR file
/*********************************************************************/
#ifndef ARCHIVE_SUMMARY_HPP
#define ARCHIVE_SUMMARY_HPP
#include "../my_config.h"
#include <string>
#include "infinint.hpp"
#include "entree_stats.hpp"
namespace libdar
{
class archive_summary
{
public:
archive_summary() { clear(); };
archive_summary(const archive_summary & ref) = default;
archive_summary(archive_summary && ref) noexcept = default;
archive_summary & operator = (const archive_summary & ref) = default;
archive_summary & operator = (archive_summary && ref) noexcept = default;
~archive_summary() = default;
// GETTINGS
const infinint & get_slice_size() const { return slice_size; };
const infinint & get_first_slice_size() const { return first_slice_size; };
const infinint & get_last_slice_size() const { return last_slice_size; };
const infinint & get_ref_slice_size() const { return ref_slice_size; };
const infinint & get_ref_first_slice_size() const { return ref_first_slice_size; };
const infinint & get_slice_number() const { return slice_number; };
const infinint & get_archive_size() const { return archive_size; };
const infinint & get_catalog_size() const { return catalog_size; };
const infinint & get_storage_size() const { return storage_size; };
const infinint & get_data_size() const { return data_size; };
const entree_stats & get_contents() const { return contents; };
const std::string & get_edition() const { return edition; };
const std::string & get_compression_algo() const { return algo_zip; };
const std::string & get_user_comment() const { return user_comment; };
const std::string & get_cipher() const { return cipher; };
const std::string & get_asym() const { return asym; };
bool get_signed() const { return is_signed; };
bool get_tape_marks() const { return tape_marks; };
const std::string & get_in_place() const { return in_place; };
const infinint & get_compression_block_size() const { return compr_block_size; };
const std::string & get_salt() const { return salt; };
const infinint & get_iteration_count() const { return iteration_count; };
const std::string & get_kdf_hash() const { return kdf_hash; };
// SETTINGS
void set_slice_size(const infinint & arg) { slice_size = arg; };
void set_first_slice_size(const infinint & arg) { first_slice_size = arg; };
void set_last_slice_size(const infinint & arg) { last_slice_size = arg; };
void set_ref_slice_size(const infinint & arg) { ref_slice_size = arg; };
void set_ref_first_slice_size(const infinint & arg) { ref_first_slice_size = arg; };
void set_slice_number(const infinint & arg) { slice_number = arg; };
void set_archive_size(const infinint & arg) { archive_size = arg; };
void set_catalog_size(const infinint & arg) { catalog_size = arg; };
void set_storage_size(const infinint & arg) { storage_size = arg; };
void set_data_size(const infinint & arg) { data_size = arg; };
void set_contents(const entree_stats & arg) { contents = arg; };
void set_edition(const std::string & arg) { edition = arg; };
void set_compression_algo(const std::string & arg) { algo_zip = arg; };
void set_user_comment(const std::string & arg) { user_comment = arg; };
void set_cipher(const std::string & arg) { cipher = arg; };
void set_asym(const std::string & arg) { asym = arg; };
void set_signed(bool arg) { is_signed = arg; };
void set_tape_marks(bool arg) { tape_marks = arg; };
void set_in_place(const std::string & arg) { in_place = arg; };
void set_compression_block_size(const infinint & arg) { compr_block_size = arg; };
void set_salt(const std::string & arg) { salt = arg; };
void set_iteration_count(const infinint & arg) { iteration_count = arg; };
void set_kdf_hash(const std::string & arg) { kdf_hash = arg; };
void clear();
private:
infinint slice_size;
infinint first_slice_size;
infinint last_slice_size;
infinint ref_slice_size;
infinint ref_first_slice_size;
infinint slice_number;
infinint archive_size;
infinint catalog_size;
infinint storage_size;
infinint data_size;
entree_stats contents;
std::string edition;
std::string algo_zip;
std::string user_comment;
std::string cipher;
std::string asym;
bool is_signed;
bool tape_marks;
std::string in_place;
infinint compr_block_size;
std::string salt;
infinint iteration_count;
std::string kdf_hash;
};
} // end of namespace
#endif
libdar::infinint
the arbitrary large positive integer class
Definition real_infinint.hpp:62
entree_stats.hpp
datastructure holding the nature of file present in a given archive
libdar::archive_summary::iteration_count
infinint iteration_count
iteration count for KDF routine
Definition archive_summary.hpp:131
libdar::archive_summary::salt
std::string salt
the salt
Definition archive_summary.hpp:130
libdar::archive_summary::is_signed
bool is_signed
whether the archive is signed
Definition archive_summary.hpp:126
libdar::archive_summary::edition
std::string edition
archive format
Definition archive_summary.hpp:121
libdar::archive_summary::archive_size
infinint archive_size
total size of the archive
Definition archive_summary.hpp:116
libdar::archive_summary::slice_size
infinint slice_size
slice of the middle slice or zero if not applicable
Definition archive_summary.hpp:110
libdar::archive_summary::last_slice_size
infinint last_slice_size
slice of the last slice or zero if not applicable
Definition archive_summary.hpp:112
libdar::archive_summary::user_comment
std::string user_comment
user comment
Definition archive_summary.hpp:123
libdar::archive_summary::in_place
std::string in_place
in_place path empty string if absent
Definition archive_summary.hpp:128
libdar::archive_summary::ref_first_slice_size
infinint ref_first_slice_size
slice of the first slice of the archive of reference
Definition archive_summary.hpp:114
libdar::archive_summary::contents
entree_stats contents
nature of saved files
Definition archive_summary.hpp:120
libdar::archive_summary::tape_marks
bool tape_marks
whether the archive has tape marks (for sequential reading)
Definition archive_summary.hpp:127
libdar::archive_summary::storage_size
infinint storage_size
amount of byte used to store (compressed/encrypted) data
Definition archive_summary.hpp:118
libdar::archive_summary::slice_number
infinint slice_number
number of slices composing the archive of zero if unknown
Definition archive_summary.hpp:115
libdar::archive_summary::cipher
std::string cipher
encryption algorithm
Definition archive_summary.hpp:124
libdar::archive_summary::data_size
infinint data_size
amount of data saved (once uncompressed/unciphered)
Definition archive_summary.hpp:119
libdar::archive_summary::ref_slice_size
infinint ref_slice_size
slice of the slice of the archive of reference
Definition archive_summary.hpp:113
libdar::archive_summary::algo_zip
std::string algo_zip
compression algorithm
Definition archive_summary.hpp:122
libdar::archive_summary::catalog_size
infinint catalog_size
catalogue size if known, zero if not
Definition archive_summary.hpp:117
libdar::archive_summary::first_slice_size
infinint first_slice_size
slice of the first slices or zero if not applicable
Definition archive_summary.hpp:111
libdar::archive_summary::kdf_hash
std::string kdf_hash
kdf hash algo
Definition archive_summary.hpp:132
libdar::archive_summary::compr_block_size
infinint compr_block_size
compression block size, or zero if stream compression is used
Definition archive_summary.hpp:129
libdar::archive_summary::asym
std::string asym
asymetrical encryption
Definition archive_summary.hpp:125
infinint.hpp
switch module to limitint (32 ou 64 bits integers) or infinint
my_config.h
include macro defined by the configure script and some specific additional ones
libdar
libdar namespace encapsulate all libdar symbols
Definition archive.hpp:47
libdar::entree_stats
holds the statistics contents of a catalogue
Definition entree_stats.hpp:49