#include <UT_IStream.h>

Inheritance diagram for UT_IFStream:

Public Member Functions
	UT_IFStream ()

	~UT_IFStream () override

bool	close ()


	UT_IFStream (const UT_StringHolder &filename, UT_ISTREAM_READTYPE binary=UT_ISTREAM_BINARY, const UT_Options *options=NULL, bool bufferable=true)

bool	open (const UT_StringHolder &filename, UT_ISTREAM_READTYPE binary=UT_ISTREAM_BINARY, const UT_Options *options=NULL, bool bufferable=true)

Public Member Functions inherited from UT_IStream
	UT_IStream ()

	UT_IStream (FILE *fp, UT_ISTREAM_READTYPE binary=UT_ISTREAM_BINARY, bool bufferable=true)

	UT_IStream (std::istream &is, UT_ISTREAM_READTYPE binary=UT_ISTREAM_BINARY, bool bufferable=true)

	UT_IStream (const char *buffer, size_t bufsize, UT_ISTREAM_READTYPE binary)

	UT_IStream (const UT_WorkBuffer &buffer, UT_ISTREAM_READTYPE binary=UT_ISTREAM_ASCII)

virtual	~UT_IStream ()

void	init (FILE *fp, UT_ISTREAM_READTYPE binary=UT_ISTREAM_BINARY, bool bufferable=true)

void	init (std::istream &is, UT_ISTREAM_READTYPE binary=UT_ISTREAM_BINARY, bool bufferable=true)

void	init (const char *buffer, size_t bufsize, UT_ISTREAM_READTYPE binary)

void	init (const UT_WorkBuffer &buffer, UT_ISTREAM_READTYPE binary=UT_ISTREAM_ASCII)

virtual int64	getMemoryUsage (bool inclusive) const

const char *	getFilename () const

void	setIsFile (bool isFile)

void	setIsSubStream (bool is_sub_stream)

bool	isSubStream () const

bool	isRandomAccessFile (UT_WorkBuffer &filename) const

FileSystemType	getFileSystemType () const

int	getFileDescriptor () const

bool	isEof () const

bool	isError () const

void	setError (bool is_error)

bool	isAscii () const

bool	isBinary () const

void	setVersion (int version)

int	getVersion () const

void	setLabel (const UT_StringHolder &label)

const UT_StringHolder &	getLabel () const

UT_IStreamBuf *	getStreamBuffer ()

UT_UniquePtr< UT_IStream >	getSubStream (exint start, exint nbytes)

UT_UniquePtr< UT_IStream >	getZlibStream ()

UT_UniquePtr< UT_IStream >	getGzipStream ()

UT_UniquePtr< UT_IStream >	getBloscStream ()

UT_UniquePtr< UT_IStream >	getSCStream ()

bool	getLine (UT_WorkBuffer &buffer, int end='\n')

bool	skipLine (int end='\n')

bool	getWord (UT_WorkBuffer &buffer)

bool	getString (UT_WorkBuffer &buffer)

bool	skipWhitespace (int64 &line_count, int64 &line_start_pos)

bool	skipWhitespace ()

bool	getJSONWord (UT_WorkBuffer &buffer, bool &real)

bool	getAll (UT_WorkBuffer &buffer)

bool	getAllAscii (UT_WorkBuffer &buffer)

bool	getNonCommentWord (UT_WorkBuffer &buffer, int comment='#')

exint	getNonCommentLine (UT_WorkBuffer &buffer, int comment='#', bool strip_inline_comments=true)

bool	checkNonCommentToken (const char *expected, int comment='#')

bool	checkToken (const char *expected)

SYS_FORCE_INLINE int	getc ()

SYS_FORCE_INLINE int	peek ()

SYS_FORCE_INLINE exint	ungetc ()

SYS_FORCE_INLINE exint	unwind (exint amount)

exint	read (bool *array, exint sz=1)

exint	read (int16 *array, exint sz=1)

exint	read (uint16 *array, exint sz=1)

exint	read (int32 *array, exint sz=1)

exint	read (uint32 *array, exint sz=1)

exint	read (int64 *array, exint sz=1)

exint	read (uint64 *array, exint sz=1)

bool	read (UT_String &string)

bool	read (std::string &bytes)

bool	read (UT_StringHolder &string)

template<typename SOURCE_TYPE , typename T >
exint	read (T *array, exint sz, exint max_elem)

exint	read (bool *array, exint sz, exint max_elem)

bool	readBinaryString (UT_String &str, UT_ISTREAM_RLE_IO startbits)

bool	readBinaryString (UT_StringHolder &string, UT_ISTREAM_RLE_IO startbits)

exint	readStringRLE (UT_ISTREAM_RLE_IO startbits)

bool	readBool (bool &result)

bool	readChar (char &result)

bool	areadChar (char &result)

exint	bread (bool *buffer, exint size=1)

exint	bread (char *buffer, exint asize=1)

exint	bread (unsigned char *buffer, exint asize=1)

exint	bread (signed char *buffer, exint asize=1)

exint	bread (int16 *buffer, exint asize=1)

exint	bread (uint16 *buffer, exint asize=1)

exint	bread (int32 *buffer, exint asize=1)

exint	bread (uint32 *buffer, exint asize=1)

exint	bread (int64 *buffer, exint asize=1)

exint	bread (uint64 *buffer, exint asize=1)

bool	bread (UT_String &str)

bool	bread (std::string &bytes)

bool	bread (UT_StringHolder &bytes)

bool	bread (UT_WorkBuffer &bytes)

exint	aread (bool *buffer, exint asize=1)

exint	aread (int16 *buffer, exint asize=1)

exint	aread (uint16 *buffer, exint asize=1)

exint	aread (int32 *buffer, exint asize=1)

exint	aread (uint32 *buffer, exint asize=1)

exint	aread (int64 *buffer, exint asize=1)

exint	aread (uint64 *buffer, exint asize=1)

exint	aread (fpreal16 *buffer, exint asize=1)

exint	aread (fpreal32 *buffer, exint asize=1)

exint	aread (fpreal64 *buffer, exint asize=1)

bool	aread (UT_String &str)

bool	aread (std::string &bytes)

bool	aread (UT_StringHolder &bytes)

bool	aread (UT_WorkBuffer &bytes)

exint	tellg () const

bool	seekg (exint pos, int seekdir=UT_SEEK_BEG)

template<typename SOURCE_TYPE >
exint	read (int32 *val, exint sz=1)

template<typename SOURCE_TYPE >
exint	read (int64 *val, exint sz=1)

template<typename SOURCE_TYPE >
exint	read (fpreal16 *val, exint sz=1)

template<typename SOURCE_TYPE >
exint	read (fpreal32 *val, exint sz=1)

template<typename SOURCE_TYPE >
exint	read (fpreal64 *val, exint sz=1)

template<typename SOURCE_TYPE >
exint	bread (int32 *buffer, exint asize=1)

template<typename SOURCE_TYPE >
exint	bread (int64 *buffer, exint asize=1)

template<typename SOURCE_TYPE >
exint	bread (fpreal16 *buffer, exint asize=1)

template<typename SOURCE_TYPE >
exint	bread (fpreal32 *buffer, exint asize=1)

template<typename SOURCE_TYPE >
exint	bread (fpreal64 *buffer, exint asize=1)

Additional Inherited Members
Public Types inherited from UT_IStream
enum	{ UT_SEEK_BEG =UT_IOS_SEEK_BEG, UT_SEEK_CUR =UT_IOS_SEEK_CUR, UT_SEEK_END =UT_IOS_SEEK_END }

enum	FileSystemType { UT_FSYSTEM_UNKNOWN, UT_FSYSTEM_LOCAL, UT_FSYSTEM_NETWORK }
	Return whether the stream refers to a local drive or a network path. More...

Static Public Member Functions inherited from UT_IStream
static void	setStdinCompatible (bool state)

Protected Member Functions inherited from UT_IStream
	UT_IStream (const UT_StringHolder &filename, const UT_Options *open_options, bool bufferable)

	UT_IStream (UT_IStreamBuf *sbuf, UT_ISTREAM_READTYPE binary)

void	initCommon (UT_ISTREAM_READTYPE binary)

bool	readString (UT_String &str, bool binary)

bool	readStdString (std::string &bytes, bool binary)

bool	readStringHolder (UT_StringHolder &bytes, bool binary)

bool	readWorkBuffer (UT_WorkBuffer &bytes, bool binary)

void	setError ()

void	clearError ()

Protected Attributes inherited from UT_IStream
UT_IStreamBuf *	myStream

UT_StringHolder	myLabel

int	myVersion

bool	myBinary

bool	myEof

bool	myError

bool	myIsFile

bool	myIsSubStream

Detailed Description

Examples:: standalone/geo2voxel.C.

Definition at line 545 of file UT_IStream.h.

Constructor & Destructor Documentation

UT_IFStream::UT_IFStream ( )

UT_IFStream::UT_IFStream	(	const UT_StringHolder &	filename,
		UT_ISTREAM_READTYPE	binary = `UT_ISTREAM_BINARY`,
		const UT_Options *	options = `NULL`,
		bool	bufferable = `true`
	)

Open a file for input

Known Options cache_mode "random" or "sequential" hint ascii true or false (performs CRLF translation on Windows)

UT_IFStream::~UT_IFStream ( )

override

Member Function Documentation

bool UT_IFStream::close ( )

bool UT_IFStream::open	(	const UT_StringHolder &	filename,
		UT_ISTREAM_READTYPE	binary = `UT_ISTREAM_BINARY`,
		const UT_Options *	options = `NULL`,
		bool	bufferable = `true`
	)

Open a file for input

Known Options cache_mode "random" or "sequential" hint ascii true or false (performs CRLF translation on Windows)

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

UT/UT_IStream.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation