Disk ARchive  2.7.14
Full featured and portable backup and archiving tool
Public Member Functions | Protected Member Functions | Private Attributes | List of all members
libdar::hash_fichier Class Reference

manages the generation of a hash More...

#include <hash_fichier.hpp>

+ Inheritance diagram for libdar::hash_fichier:
+ Collaboration diagram for libdar::hash_fichier:

Public Member Functions

 hash_fichier (const std::shared_ptr< user_interaction > &dialog, fichier_global *under, const std::string &under_filename, fichier_global *hash_file, hash_algo algo)
 
 hash_fichier (const hash_fichier &ref)=delete
 copy constructor
 
 hash_fichier (hash_fichier &&ref) noexcept=delete
 move constructor
 
hash_fichieroperator= (const hash_fichier &ref)=delete
 assignment operator
 
hash_fichieroperator= (hash_fichier &&ref) noexcept=delete
 move operator
 
 ~hash_fichier ()
 destructor
 
virtual void change_ownership (const std::string &user, const std::string &group) override
 set the ownership of the file
 
virtual void change_permission (U_I perm) override
 change the permission of the file
 
virtual infinint get_size () const override
 return the size of the file
 
virtual void fadvise (advise adv) const override
 set posix_fadvise for the whole file
 
virtual bool skippable (skippability direction, const infinint &amount) override
 whether the implementation is able to skip More...
 
virtual bool skip (const infinint &pos) override
 skip at the absolute position More...
 
virtual bool skip_to_eof () override
 skip to the end of file
 
virtual bool skip_relative (S_I x) override
 skip relatively to the current position
 
virtual bool truncatable (const infinint &pos) const override
 whether the implementation is able to truncate to the given position
 
virtual infinint get_position () const override
 get the current read/write position
 
void set_only_hash ()
 for debugging purposes only
 
- Public Member Functions inherited from libdar::fichier_global
 fichier_global (const std::shared_ptr< user_interaction > &dialog, gf_mode mode)
 constructor More...
 
 fichier_global (const fichier_global &ref)=default
 copy constructor
 
 fichier_global (fichier_global &&ref) noexcept=default
 move constructor
 
fichier_globaloperator= (const fichier_global &ref)=default
 assignment operator
 
fichier_globaloperator= (fichier_global &&ref) noexcept=default
 move operator
 
- Public Member Functions inherited from libdar::generic_file
 generic_file (gf_mode m)
 main constructor
 
 generic_file (const generic_file &ref)
 copy constructor
 
 generic_file (generic_file &&ref) noexcept
 move constructor
 
generic_fileoperator= (const generic_file &ref)
 assignment operator
 
generic_fileoperator= (generic_file &&ref) noexcept
 move operator
 
 ~generic_file () noexcept(false)
 virtual destructor, More...
 
void terminate ()
 destructor-like call, except that it is allowed to throw exceptions
 
bool operator== (generic_file &ref)
 
bool operator!= (generic_file &ref)
 
gf_mode get_mode () const
 retreive the openning mode for this object
 
void read_ahead (const infinint &amount)
 
void ignore_read_ahead (bool mode)
 
virtual U_I read (char *a, U_I size) override
 read data from the generic_file inherited from proto_generic_file
 
virtual void write (const char *a, U_I size) override
 write data to the generic_file inherited from proto_generic_file
 
void write (const std::string &arg)
 write a string to the generic_file More...
 
S_I read_back (char &a)
 skip back one char, read on char and skip back one char
 
S_I read_forward (char &a)
 read one char
 
virtual void truncate (const infinint &pos)
 truncate file at the given offset More...
 
virtual void copy_to (generic_file &ref)
 copy all data from current position to the object in argument
 
virtual void copy_to (generic_file &ref, const infinint &crc_size, crc *&value)
 copy all data from the current position to the object in argument and computes a CRC value of the transmitted data More...
 
U_32 copy_to (generic_file &ref, U_32 size)
 small copy (up to 4GB) with CRC calculation
 
infinint copy_to (generic_file &ref, infinint size)
 copy the given amount to the object in argument
 
bool diff (generic_file &f, const infinint &me_read_ahead, const infinint &you_read_ahead, const infinint &crc_size, crc *&value)
 compares the contents with the object in argument More...
 
bool diff (generic_file &f, const infinint &me_read_ahead, const infinint &you_read_ahead, const infinint &crc_size, crc *&value, infinint &err_offset)
 
void reset_crc (const infinint &width)
 reset CRC on read or writen data More...
 
bool crc_status () const
 to known whether CRC calculation is activated or not
 
crcget_crc ()
 get CRC of the transfered date since last reset More...
 
void sync_write ()
 write any pending data
 
void flush_read ()
 be ready to read at current position, reseting all pending data for reading, cached and in compression engine for example
 
- Public Member Functions inherited from libdar::proto_generic_file
 proto_generic_file (const proto_generic_file &ref)=default
 copy constructor
 
 proto_generic_file (proto_generic_file &&ref) noexcept=default
 move constructor
 
proto_generic_fileoperator= (const proto_generic_file &ref)=default
 assignment operator
 
proto_generic_fileoperator= (proto_generic_file &&ref) noexcept=default
 move operator
 
virtual ~proto_generic_file () noexcept(false)
 virtual destructor More...
 
- Public Member Functions inherited from libdar::thread_cancellation
 thread_cancellation ()
 the constructor
 
 thread_cancellation (const thread_cancellation &ref)=default
 copy constructor
 
 thread_cancellation (thread_cancellation &&ref) noexcept=default
 move constructor
 
thread_cancellationoperator= (const thread_cancellation &ref)=default
 assignment operator
 
thread_cancellationoperator= (thread_cancellation &&ref) noexcept=default
 move operator
 
virtual ~thread_cancellation () noexcept(false)
 the destructor
 
void check_self_cancellation () const
 Checkpoint test : whether the current libdar call must abort or not. More...
 
void block_delayed_cancellation (bool mode)
 
- Public Member Functions inherited from libdar::mem_ui
 mem_ui (const std::shared_ptr< user_interaction > &dialog)
 constructor More...
 
 mem_ui (const mem_ui &ref)=default
 the copy constructor More...
 
 mem_ui (mem_ui &&ref) noexcept=default
 the move constructor
 
mem_uioperator= (const mem_ui &ref)=default
 assignement operator More...
 
mem_uioperator= (mem_ui &&ref) noexcept=default
 move operator
 
virtual ~mem_ui () noexcept(false)
 destructor More...
 

Protected Member Functions

virtual void inherited_read_ahead (const infinint &amount) override
 tells the object that several calls to read() will follow to probably obtain at least the given amount of data More...
 
virtual U_I fichier_global_inherited_write (const char *a, U_I size) override
 replaces generic_file::inherited_write() method, to allow the return of partial writings More...
 
virtual bool fichier_global_inherited_read (char *a, U_I size, U_I &read, std::string &message) override
 replaces generic_file::inherited_read() method, to allow the return of partial reading More...
 
virtual void inherited_truncate (const infinint &pos) override
 truncate file at the give offset More...
 
virtual void inherited_sync_write () override
 write down any pending data More...
 
virtual void inherited_flush_read () override
 reset internal engine, flush caches in order to read the data at current position More...
 
virtual void inherited_terminate () override
 destructor-like call, except that it is allowed to throw exceptions More...
 
- Protected Member Functions inherited from libdar::generic_file
void set_mode (gf_mode x)
 
bool is_terminated () const
 
- Protected Member Functions inherited from libdar::mem_ui
user_interactionget_ui () const
 get access to the user_interaction object More...
 
std::shared_ptr< user_interactionget_pointer () const
 get access to the shared_ptr pointing to the user_interaction
 

Private Attributes

fichier_globalref
 
fichier_globalhash_ref
 
bool only_hash
 if set, avoids copying data to file, only compute hash (debugging purpose)
 
std::string ref_filename
 
U_I hash_gcrypt
 
bool eof
 
bool hash_dumped
 

Additional Inherited Members

- Public Types inherited from libdar::fichier_global
enum  advise {
  advise_normal , advise_sequential , advise_random , advise_noreuse ,
  advise_willneed , advise_dontneed
}
 
- Public Types inherited from libdar::generic_file
enum  skippability { skip_backward , skip_forward }
 
- Static Public Member Functions inherited from libdar::thread_cancellation
static U_I count ()
 method for debugging/control purposes
 

Detailed Description

manages the generation of a hash

Definition at line 59 of file hash_fichier.hpp.

Constructor & Destructor Documentation

◆ hash_fichier()

libdar::hash_fichier::hash_fichier ( const std::shared_ptr< user_interaction > &  dialog,
fichier_global under,
const std::string &  under_filename,
fichier_global hash_file,
hash_algo  algo 
)

hash_file constructor

Parameters
[in]dialogfor user interaction
[in]underpoints to an object where to write data to
[in]under_filenamename of the plain file we write to, this argument is required to build the hash file
[in]hash_filepoints to an object where to drop the hash file once writings are finished
[in]algohash algorithm to use. hash_none is not an acceptable value
Note
if the constructor succeed, the objects pointed to by under and hash_file are owned and deleted by this hash_file object

Member Function Documentation

◆ fichier_global_inherited_read()

virtual bool libdar::hash_fichier::fichier_global_inherited_read ( char *  a,
U_I  size,
U_I &  read,
std::string &  message 
)
overrideprotectedvirtual

replaces generic_file::inherited_read() method, to allow the return of partial reading

a partial reading is signaled by the inherited class by returning false

Parameters
[in]apoints to the area where to store read data
[in]sizeis the available place to store data
[out]readis the total amount of data read so far
[out]messageis the request to send to the user upon partial reading
Returns
true if the reading is full (either read the maximum allowed data or reached end of file) false is returned if a user interaction can let the reading go further the message to display to the user asking him for action. He will also be proposed to abort the current operation.

Implements libdar::fichier_global.

◆ fichier_global_inherited_write()

virtual U_I libdar::hash_fichier::fichier_global_inherited_write ( const char *  a,
U_I  size 
)
overrideprotectedvirtual

replaces generic_file::inherited_write() method, to allow the return of partial writings

a partial writing is allowed when no space is available for writing this let global_ficher interact with the user asking whether it can make place or if (s)he wants to abort

Parameters
[in]apoints to the start of the area of data to write
[in]sizeis the size in byte of the data to write
Returns
the amount of byte wrote. If the returned value is less than size, this is a partial write, and is assumed that free storage space is missing to complete the operation

Implements libdar::fichier_global.

◆ inherited_flush_read()

virtual void libdar::hash_fichier::inherited_flush_read ( )
inlineoverrideprotectedvirtual

reset internal engine, flush caches in order to read the data at current position

Note
when the object relies on external object or system object to fetch the data from for reading, when a call to (inherited_)flush_read() occurs, the current object must not assume that any previously read data is still valid if it has internal buffers or the like and it should flush them asap. This call must not propagate the flush_read to any other gneric_file object it could rely on

Implements libdar::generic_file.

Definition at line 119 of file hash_fichier.hpp.

◆ inherited_read_ahead()

virtual void libdar::hash_fichier::inherited_read_ahead ( const infinint amount)
inlineoverrideprotectedvirtual

tells the object that several calls to read() will follow to probably obtain at least the given amount of data

Parameters
[in]amountis the maximum expected amount of data that is known to be read
Note
this call may be implemented as a do-nothing call, its presence is only to allow optimization when possible, like in multi-threaded environment

Implements libdar::generic_file.

Definition at line 112 of file hash_fichier.hpp.

References libdar::generic_file::read_ahead().

◆ inherited_sync_write()

virtual void libdar::hash_fichier::inherited_sync_write ( )
inlineoverrideprotectedvirtual

write down any pending data

Note
called after sanity checks from generic_file::sync_write() this method's role is to write down any data pending for writing in the current object it has not to be propagated to other gneric_file object this object could rely on

Implements libdar::generic_file.

Definition at line 118 of file hash_fichier.hpp.

◆ inherited_terminate()

virtual void libdar::hash_fichier::inherited_terminate ( )
overrideprotectedvirtual

destructor-like call, except that it is allowed to throw exceptions

Note
this method must never be called directly but using terminate() instead, generic_file class manages it to never be called more than once

Implements libdar::generic_file.

◆ inherited_truncate()

virtual void libdar::hash_fichier::inherited_truncate ( const infinint pos)
inlineoverrideprotectedvirtual

truncate file at the give offset

Note
if pos is greater than the current file size, this call may do nothing (not even enlarging the file)
this call should always fail on a read-only generic_file
implementation must throw exception if truncate is not possible for other reason than read/write access mode

Implements libdar::generic_file.

Definition at line 117 of file hash_fichier.hpp.

◆ skip()

virtual bool libdar::hash_fichier::skip ( const infinint pos)
inlineoverridevirtual

skip at the absolute position

Parameters
[in]posthe offset in byte where next read/write operation must start
Returns
true if operation was successfull and false if the requested position is not valid (after end of file)
Note
if requested position is not valid the reading/writing cursor must be set to the closest valid position

Implements libdar::generic_file.

Definition at line 101 of file hash_fichier.hpp.

References libdar::generic_file::get_position().

◆ skippable()

virtual bool libdar::hash_fichier::skippable ( skippability  direction,
const infinint amount 
)
inlineoverridevirtual

whether the implementation is able to skip

Note
the capability to skip does not mean that skip_relative() or skip() will succeed, but rather that the inherited class implementation does not by construction forbid the requested skip (like inherited class providing a generic_file interface of an anonymous pipe for example)

Implements libdar::generic_file.

Definition at line 100 of file hash_fichier.hpp.


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