A wrapped std::ofstream with possible compression handling (ogzstream) that behaves much like a std::unique_ptr. More...

#include <fstreamPointer.H>

Inheritance diagram for ofstreamPointer:

[legend]

Public Member Functions
	ofstreamPointer (const ofstreamPointer &)=delete
	No copy construct.
	ofstreamPointer (ofstreamPointer &&)=default
	Move construct.
void	operator= (const ofstreamPointer &)=delete
	No copy assignment.
ofstreamPointer &	operator= (ofstreamPointer &&)=default
	Move assignment.
	~ofstreamPointer ()=default
	Destructor.
	ofstreamPointer () noexcept
	Default construct (empty).
	ofstreamPointer (std::nullptr_t)
	Construct as null output stream (Foam::ocountstream).
	ofstreamPointer (const fileName &pathname, IOstreamOption streamOpt=IOstreamOption(), IOstreamOption::appendType append=IOstreamOption::NO_APPEND, bool atomic=false)
	Construct from pathname, option, append, file handling atomic.
	ofstreamPointer (const fileName &pathname, IOstreamOption::compressionType comp, IOstreamOption::appendType append=IOstreamOption::NO_APPEND, bool atomic=false)
	Construct from pathname, compression, append, file handling atomic.
	operator bool () const noexcept
	True if it holds a valid pointer.
std::ostream *	get () noexcept
	The stream pointer (ofstream or ogzstream).
const std::ostream *	get () const noexcept
	The stream pointer (ofstream or ogzstream).
IOstreamOption::compressionType	whichCompression () const
	Which compression type?
bool	is_appending () const noexcept
	True if opened in append mode and file already existed.
bool	is_atomic () const noexcept
	True if file creation behaves as atomic.
std::ostream *	release () noexcept
	Return managed pointer and release ownership.
void	reset (std::ostream *ptr) noexcept
	Replace the managed pointer.
std::ostream &	operator* ()
	Reference to the stream (no nullptr checking).
const std::ostream &	operator* () const
	Const-reference to the stream (no nullptr checking).
std::ostream *	operator-> () noexcept
	Pointer dereference.
const std::ostream *	operator-> () const noexcept
	Pointer dereference.

Static Public Member Functions
static bool	supports_gz () noexcept
	True if compiled with libz support.

Protected Member Functions
void	reopen (const std::string &pathname)
	Reopen for compressed/non-compressed. Discards append status.
void	close (const std::string &pathname)
	Close stream and rename file.

Detailed Description

A wrapped std::ofstream with possible compression handling (ogzstream) that behaves much like a std::unique_ptr.

Note: No operator bool to avoid inheritance ambiguity with std::ios::operator bool.

Source files

Definition at line 239 of file fstreamPointer.H.

Constructor & Destructor Documentation

◆ ofstreamPointer() [1/6]

ofstreamPointer ( const ofstreamPointer & )

delete

No copy construct.

References ofstreamPointer().

Referenced by OFstream::OFstream(), OFstream::OFstream(), ofstreamPointer(), ofstreamPointer(), ofstreamPointer(), operator=(), operator=(), and ~ofstreamPointer().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ofstreamPointer() [2/6]

ofstreamPointer ( ofstreamPointer && )

default

Move construct.

References ofstreamPointer().

Here is the call graph for this function:

◆ ~ofstreamPointer()

~ofstreamPointer ( )

default

Destructor.

References append(), Foam::noexcept, ofstreamPointer(), and supports_gz().

Here is the call graph for this function:

◆ ofstreamPointer() [3/6]

ofstreamPointer ( )

noexcept

Default construct (empty).

Definition at line 81 of file fstreamPointers.C.

References Foam::noexcept.

◆ ofstreamPointer() [4/6]

ofstreamPointer ( std::nullptr_t )

explicit

Construct as null output stream (Foam::ocountstream).

Definition at line 88 of file fstreamPointers.C.

◆ ofstreamPointer() [5/6]

ofstreamPointer	(	const fileName &	pathname,
		IOstreamOption	streamOpt = IOstreamOption(),
		IOstreamOption::appendType	append = IOstreamOption::NO_APPEND,
		bool	atomic = false )

explicit

Construct from pathname, option, append, file handling atomic.

Parameters

pathname	The file name to open for writing
streamOpt	Respects (UNCOMPRESSED \| COMPRESSED)
append	Open in specified append mode
atomic	Write into temporary file (not target file). This option should only be used with a stream wrapper (eg, OFstream) that handles the final renaming.

Note: There are two different append modes: append at every write, or only append after opening.

Definition at line 95 of file fstreamPointers.C.

References append(), IOstreamOption::APPEND_APP, IOstreamOption::APPEND_ATE, IOstreamOption::COMPRESSED, IOstreamOption::compression(), Foam::endl(), fileName::FILE, filePtr, Foam::nl, IOstreamOption::NO_APPEND, Foam::rm(), fileName::SYMLINK, Foam::type(), IOstreamOption::UNCOMPRESSED, fileName::UNDEFINED, and Foam::Warning.

Here is the call graph for this function:

◆ ofstreamPointer() [6/6]

ofstreamPointer	(	const fileName &	pathname,
		IOstreamOption::compressionType	comp,
		IOstreamOption::appendType	append = IOstreamOption::NO_APPEND,
		bool	atomic = false )

Construct from pathname, compression, append, file handling atomic.

Parameters

pathname	The file name to open for writing
comp	UNCOMPRESSED \| COMPRESSED
append	Open in append mode
atomic	Write into temporary file (not target file). This option should only be used with a stream wrapper (eg, OFstream) that handles the final renaming.

Definition at line 289 of file fstreamPointers.C.

References append(), and ofstreamPointer().

Here is the call graph for this function: