Bzip2InputStream Class Reference

Byte stream for reading bzip2 compressed XML files. More...

#include <OpenMS/FORMAT/Bzip2InputStream.h>

Inheritance diagram for Bzip2InputStream:

Public Member Functions
	Bzip2InputStream (const std::string &file_name)
	Constructor.
	Bzip2InputStream (const char *const file_name)
	~Bzip2InputStream () override
	Destructor.
bool	getIsOpen () const
	returns true if file is open
UInt64	curPos () const override
	returns the current position in the file
Size	readBytes (unsigned char *const to_fill, const Size max_to_read) override
	writes bytes into buffer from file
Public Member Functions inherited from InputStream
virtual	~InputStream ()=default
virtual void	cancel ()

Private Member Functions
	Bzip2InputStream ()
	Bzip2InputStream (const Bzip2InputStream &stream)
Bzip2InputStream &	operator= (const Bzip2InputStream &stream)

Private Attributes
Bzip2Ifstream *	bzip2_
	pointer to an compression stream
UInt64	file_current_index_
	current index of the actual file

Detailed Description

Byte stream for reading bzip2 compressed XML files.

Constructor & Destructor Documentation

Bzip2InputStream() [1/4]

Bzip2InputStream ( const std::string &  file_name )

explicit

Constructor.

Bzip2InputStream() [2/4]

Bzip2InputStream ( const char *const  file_name )

explicit

~Bzip2InputStream()

~Bzip2InputStream ( )

override

Destructor.

Bzip2InputStream() [3/4]

Bzip2InputStream ( )

private

Bzip2InputStream() [4/4]

Bzip2InputStream ( const Bzip2InputStream &  stream )

private

Member Function Documentation

curPos()

UInt64 curPos ( ) const

inlineoverridevirtual

returns the current position in the file

Note

OpenMS byte stream interface

Implements InputStream.

References Bzip2InputStream::file_current_index_.

getIsOpen()

bool getIsOpen ( ) const

inline

returns true if file is open

References Bzip2InputStream::bzip2_, and Bzip2Ifstream::isOpen().

operator=()

Bzip2InputStream & operator= ( const Bzip2InputStream &  stream )

private

readBytes()

Size readBytes ( unsigned char *const  to_fill, const Size  max_to_read  )

overridevirtual

writes bytes into buffer from file

Note

OpenMS byte stream interface

Parameters

[out]	to_fill	is the buffer which is written to
[in]	max_to_read	is the size of the buffer

Returns

returns the number of bytes which were actually read

Implements InputStream.

Member Data Documentation

bzip2_

Bzip2Ifstream* bzip2_

private

pointer to an compression stream

Referenced by Bzip2InputStream::getIsOpen().

file_current_index_

UInt64 file_current_index_

private

current index of the actual file

Referenced by Bzip2InputStream::curPos().