Similar to OStringStream but using an externally managed buffer for its output. More...

Inheritance diagram for UOListStream:

Collaboration diagram for UOListStream:

Public Member Functions
	UOListStream (char *buffer, size_t nbytes, IOstreamOption streamOpt=IOstreamOption())

	UOListStream (UList< char > &buffer, size_t nbytes, IOstreamOption streamOpt=IOstreamOption())

	UOListStream (UList< char > &buffer, IOstreamOption streamOpt=IOstreamOption())

template<unsigned N>
	UOListStream (FixedList< char, N > &buffer, IOstreamOption streamOpt=IOstreamOption())

template<int SizeMin>
	UOListStream (DynamicList< char, SizeMin > &buffer, IOstreamOption streamOpt=IOstreamOption())

virtual void	rewind ()

virtual void	print (Ostream &os) const

Public Member Functions inherited from UOListStreamAllocator
const UList< char >	list () const

UList< char >	list ()

label	capacity () const

label	size () const

void	rewind ()

Public Member Functions inherited from OSstream
	OSstream (const OSstream &)=default

void	operator= (const OSstream &)=delete

	OSstream (std::ostream &os, const string &streamName, IOstreamOption streamOpt=IOstreamOption())

	OSstream (std::ostream &os, const string &streamName, IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver=IOstreamOption::currentVersion, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED)

virtual const fileName &	name () const

virtual fileName &	name ()

virtual ios_base::fmtflags	flags () const

virtual bool	write (const token &tok)

virtual Ostream &	write (const char c)

virtual Ostream &	write (const char *str)

virtual Ostream &	write (const word &str)

virtual Ostream &	write (const string &str)

virtual Ostream &	writeQuoted (const std::string &str, const bool quoted=true)

virtual Ostream &	write (const int32_t val)

virtual Ostream &	write (const int64_t val)

virtual Ostream &	write (const floatScalar val)

virtual Ostream &	write (const doubleScalar val)

virtual Ostream &	write (const char *data, std::streamsize count)

virtual Ostream &	writeRaw (const char *data, std::streamsize count)

virtual bool	beginRawWrite (std::streamsize count)

virtual bool	endRawWrite ()

virtual void	indent ()

virtual ios_base::fmtflags	flags (const ios_base::fmtflags f)

virtual void	flush ()

virtual void	endl ()

virtual char	fill () const

virtual char	fill (const char fillch)

virtual int	width () const

virtual int	width (const int w)

virtual int	precision () const

virtual int	precision (const int p)

virtual std::ostream &	stdStream ()

virtual const std::ostream &	stdStream () const

Public Member Functions inherited from Ostream
	Ostream (const Ostream &)=default

virtual	~Ostream ()=default

	Ostream (IOstreamOption streamOpt=IOstreamOption())

	Ostream (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver=IOstreamOption::currentVersion, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED)

virtual Ostream &	write (const keyType &kw)

unsigned short	indentSize () const noexcept

unsigned short	indentSize (unsigned short val) noexcept

unsigned short	indentLevel () const noexcept

unsigned short	indentLevel (unsigned short val) noexcept

void	incrIndent () noexcept

void	decrIndent ()

virtual Ostream &	writeKeyword (const keyType &kw)

virtual Ostream &	beginBlock (const keyType &kw)

virtual Ostream &	beginBlock ()

virtual Ostream &	endBlock ()

virtual Ostream &	endEntry ()

template<class T >
Ostream &	writeEntry (const keyType &key, const T &value)

template<class T >
Ostream &	writeEntryIfDifferent (const word &key, const T &value1, const T &value2)

Ostream &	operator() () const

unsigned short &	indentLevel () noexcept

unsigned short &	indentSize () noexcept

Public Member Functions inherited from IOstream
	IOstream (const IOstream &)=default

virtual	~IOstream ()=default

	IOstream (IOstreamOption streamOpt=IOstreamOption())

	IOstream (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED)

fileName	relativeName () const

virtual bool	check (const char *operation) const

bool	fatalCheck (const char *operation) const

bool	opened () const noexcept

bool	closed () const noexcept

bool	good () const noexcept

bool	eof () const noexcept

bool	fail () const noexcept

bool	bad () const noexcept

	operator bool () const noexcept

bool	operator! () const noexcept

unsigned	labelByteSize () const noexcept

unsigned	scalarByteSize () const noexcept

void	setLabelByteSize (unsigned nbytes) noexcept

void	setScalarByteSize (unsigned nbytes) noexcept

template<class T = label>
std::enable_if< std::is_integral< T >::value, bool >::type	checkLabelSize () const noexcept

template<class T = scalar>
std::enable_if< std::is_floating_point< T >::value, bool >::type	checkScalarSize () const noexcept

label	lineNumber () const noexcept

label &	lineNumber () noexcept

label	lineNumber (const label num) noexcept

void	setEof () noexcept

void	setFail () noexcept

void	setBad ()

ios_base::fmtflags	setf (const ios_base::fmtflags f)

ios_base::fmtflags	setf (const ios_base::fmtflags f, const ios_base::fmtflags mask)

void	unsetf (const ios_base::fmtflags f)

void	print (Ostream &os, const int streamState) const

InfoProxy< IOstream >	info () const

Public Member Functions inherited from IOstreamOption
constexpr	IOstreamOption (streamFormat fmt=streamFormat::ASCII, compressionType comp=compressionType::UNCOMPRESSED) noexcept

constexpr	IOstreamOption (streamFormat fmt, compressionType comp, versionNumber ver) noexcept

constexpr	IOstreamOption (streamFormat fmt, versionNumber ver, compressionType comp=compressionType::UNCOMPRESSED) noexcept

	IOstreamOption (const IOstreamOption &opt, streamFormat fmt) noexcept

streamFormat	format () const noexcept

streamFormat	format (const streamFormat fmt) noexcept

streamFormat	format (const word &formatName)

compressionType	compression () const noexcept

compressionType	compression (const compressionType comp) noexcept

compressionType	compression (const word &compName)

versionNumber	version () const noexcept

versionNumber	version (const versionNumber ver) noexcept

versionNumber	version (const token &tok)

Additional Inherited Members
Public Types inherited from IOstream
enum	streamAccess : char { CLOSED = 0, OPENED }

Public Types inherited from IOstreamOption
enum	streamFormat : char { ASCII = 0, BINARY }

enum	compressionType : char { UNCOMPRESSED = 0, COMPRESSED }

Static Public Member Functions inherited from IOstream
static unsigned int	defaultPrecision () noexcept

static unsigned int	defaultPrecision (unsigned int prec) noexcept

Static Public Member Functions inherited from IOstreamOption
static streamFormat	formatEnum (const word &formatName, const streamFormat deflt=streamFormat::ASCII)

static streamFormat	formatEnum (const word &key, const dictionary &dict, const streamFormat deflt=streamFormat::ASCII)

static compressionType	compressionEnum (const word &compName, const compressionType deflt=compressionType::UNCOMPRESSED)

static compressionType	compressionEnum (const word &key, const dictionary &dict, const compressionType deflt=compressionType::UNCOMPRESSED)

Static Public Attributes inherited from IOstream
static unsigned int	precision_

Static Public Attributes inherited from IOstreamOption
static const Enum< streamFormat >	formatNames

static const versionNumber	currentVersion

Protected Types inherited from UOListStreamAllocator
typedef std::ostream	stream_type

Protected Member Functions inherited from UOListStreamAllocator
	UOListStreamAllocator (char *buffer, size_t nbytes)

void	printBufInfo (Ostream &os) const

Protected Member Functions inherited from IOstream
void	setOpened () noexcept

void	setClosed () noexcept

void	setState (std::ios_base::iostate state) noexcept

void	setGood () noexcept

Protected Attributes inherited from UOListStreamAllocator
memorybuf::out	buf_

stream_type	stream_

Protected Attributes inherited from Ostream
unsigned short	indentSize_ = 4

unsigned short	indentLevel_ = 0

Protected Attributes inherited from IOstream
std::ios_base::iostate	ioState_

streamAccess	openClosed_

unsigned char	sizeofLabel_

unsigned char	sizeofScalar_

label	lineNumber_

Static Protected Attributes inherited from Ostream
static constexpr const unsigned short	entryIndentation_ = 16

Static Protected Attributes inherited from IOstream
static fileName	staticName_

Detailed Description

Similar to OStringStream but using an externally managed buffer for its output.

This allows the output buffer to be reused and can make it easier when writing out data. It is the user's responsibility to ensure proper synchronization in the sizes. Provided that the external buffer is large enough that overflow does not occur, the following usage pattern works.

DynamicList<char> buffer(4096);     // allocate some large buffer
 
{
    UOListStream os(buffer);
    os << "content1" << " and more content";
    buffer.resize(os.size());       // synchronize sizes
}
 
something.write(buffer, buffer.size());

Although the UOListStream is quite lightweight, there may be cases where it is preferable to reuse the stream as well.

DynamicList<char> buffer(4096);     // allocate some large buffer
 
UOListStream os(buffer);
os << "content1" << " and more content";
buffer.resize(os.size());           // synchronize sizes
 
something.write(buffer, buffer.size());
 
os.rewind();
os << "content2";
buffer.resize(os.size());      // synchronize sizes
 
something.write(buffer, buffer.size());
 
// or simply using the output size directly (without sync)
os.rewind();
os << "content3";
 
something.write(buffer, os.size());

See also: Foam::IListStream Foam::OListStream Foam::UIListStream

Definition at line 174 of file UOListStream.H.

Constructor & Destructor Documentation

◆ UOListStream() [1/5]

UOListStream	(	char *	buffer,
		size_t	nbytes,
		IOstreamOption	streamOpt = `IOstreamOption()`
	)

inline

Definition at line 187 of file UOListStream.H.

◆ UOListStream() [2/5]

UOListStream	(	UList< char > &	buffer,
		size_t	nbytes,
		IOstreamOption	streamOpt = `IOstreamOption()`
	)

inline

Definition at line 199 of file UOListStream.H.

◆ UOListStream() [3/5]

UOListStream	(	UList< char > &	buffer,
		IOstreamOption	streamOpt = `IOstreamOption()`
	)

inlineexplicit

Definition at line 210 of file UOListStream.H.

◆ UOListStream() [4/5]

UOListStream	(	FixedList< char, N > &	buffer,
		IOstreamOption	streamOpt = `IOstreamOption()`
	)

inlineexplicit

Definition at line 221 of file UOListStream.H.

◆ UOListStream() [5/5]

UOListStream	(	DynamicList< char, SizeMin > &	buffer,
		IOstreamOption	streamOpt = `IOstreamOption()`
	)

inlineexplicit

Definition at line 232 of file UOListStream.H.

Member Function Documentation

◆ rewind()

virtual void rewind ( )

inlinevirtual

Definition at line 244 of file UOListStream.H.

References UOListStreamAllocator::rewind(), and IOstream::setGood().

Here is the call graph for this function:

◆ print()

void print ( Ostream & os ) const

virtual

Reimplemented from OSstream.

Definition at line 51 of file ListStream.C.

References Foam::endl(), and os().

Here is the call graph for this function:

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

src/OpenFOAM/db/IOstreams/memory/UOListStream.H
src/OpenFOAM/db/IOstreams/memory/ListStream.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ UOListStream() [1/5]

◆ UOListStream() [2/5]

◆ UOListStream() [3/5]

◆ UOListStream() [4/5]

◆ UOListStream() [5/5]

Member Function Documentation

◆ rewind()

◆ print()