libdar::trivial_sar Class Reference

"trivial sar" emulates the behavior of sar when all data must be keept in a arbitrary length single slice More...

#include <sar.hpp>

Inherits libdar::generic_file, libdar::contextual, and libdar::mem_ui.

List of all members.

Public Member Functions
	trivial_sar (user_interaction &dialog, const std::string &base_name, const std::string &extension, const path &dir, const label &data_name, const std::string &execute, bool allow_over, bool warn_over, const std::string &slice_permission, const std::string &slice_user_ownership, const std::string &slice_group_ownership, hash_algo x_hash, const infinint &min_digits, bool format_07_compatible)
	constructor to build a new single sliced archive
	trivial_sar (user_interaction &dialog, const std::string &pipename, bool lax)
	constructor to read a (single sliced) archive from a pipe
	trivial_sar (user_interaction &dialog, generic_file *f, const label &data_name, bool format_07_compatible, const std::string &execute)
	constructor to write a (single sliced) archive to a anonymous pipe
	trivial_sar (const trivial_sar &ref)
	copy constructor (disabled)
	~trivial_sar ()
	destructor
const trivial_sar &	operator= (const trivial_sar &ref)
bool	skip (const infinint &pos)
	skip at the absolute position
bool	skip_to_eof ()
	skip to the end of file
bool	skip_relative (S_I x)
	skip relatively to the current position
infinint	get_position ()
	get the current read/write position
bool	is_an_old_start_end_archive () const
const label &	get_data_name () const
Protected Member Functions
U_I	inherited_read (char *a, U_I size)
	implementation of read() operation
void	inherited_write (const char *a, U_I size)
	implementation of the write() operation
void	inherited_sync_write ()
	write down any pending data
void	inherited_terminate ()
	destructor-like call, except that it is allowed to throw exceptions

---

Detailed Description

"trivial sar" emulates the behavior of sar when all data must be keept in a arbitrary length single slice

Definition at line 222 of file sar.hpp.

---

Member Function Documentation

U_I libdar::trivial_sar::inherited_read	(	char *	a,
		U_I	size
	)		[protected, virtual]

implementation of read() operation

Parameters:

[in,out]	a	where to put the data to read
[in]	size	says how much data to read

Returns:

the exact amount of data read and put into 'a'

Note:

read as much byte as requested, up to end of file stays blocked if not enough data is available and EOF not yet met. May return less data than requested only if EOF as been reached. in other worlds, EOF is reached when returned data is stricly less than the requested data Any problem shall be reported by throwing an exception.

Implements libdar::generic_file.

void libdar::trivial_sar::inherited_sync_write

(

)

[inline, protected, virtual]

write down any pending data

Note:

this method is called after read/write mode checking from sync_write() public method;

Implements libdar::generic_file.

Definition at line 275 of file sar.hpp.

void libdar::trivial_sar::inherited_terminate

(

)

[protected, virtual]

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.

void libdar::trivial_sar::inherited_write	(	const char *	a,
		U_I	size
	)		[inline, protected, virtual]

implementation of the write() operation

Parameters:

[in]	a	what data to write
[in]	size	amount of data to write

Note:

must either write all data or report an error by throwing an exception

Implements libdar::generic_file.

Definition at line 274 of file sar.hpp.

References libdar::generic_file::write().

bool libdar::trivial_sar::skip

(

const infinint &

pos

)

[inline, virtual]

skip at the absolute position

Parameters:

[in]

pos

the 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 263 of file sar.hpp.

References libdar::generic_file::is_terminated(), and libdar::generic_file::skip().

---

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

• sar.hpp