RetroSearch Browse

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from http://www.ncbi.nlm.nih.gov/IEB/ToolBox/CPP_DOC/doxyhtml/group__CompressionStreams.html below:

NCBI C++ ToolKit: CompressionStreams

Manipulator definitions.

This allow use manipulators without ().

Definition at line 506 of file stream_util.hpp.

◆ MCompress_GZipCloudflareFile ◆ MCompress_GZipFile ◆ MCompress_LZO ◆ MCompress_Zip ◆ MCompress_ZipCloudflare ◆ MCompress_Zstd ◆ MDecompress_BZip2 ◆ MDecompress_ConcatenatedGZipFile ◆ MDecompress_GZipCloudflareFile ◆ MDecompress_GZipFile ◆ MDecompress_LZO ◆ MDecompress_Zip ◆ MDecompress_ZipCloudflare ◆ MDecompress_Zstd ◆ TCompressIProxy

Type of compression manipulators for operator>>

Definition at line 474 of file stream_util.hpp.

◆ TCompressOProxy

Type of compression manipulators for operator<<.

Definition at line 478 of file stream_util.hpp.

◆ TDecompressIProxy

Type of decompression manipulators for operator>>

Definition at line 476 of file stream_util.hpp.

◆ TDecompressOProxy

Type of decompression manipulators for operator<<.

Definition at line 480 of file stream_util.hpp.

◆ TOwnership

Bitwise OR of EOwnership.

Definition at line 134 of file stream.hpp.

◆ EDefaultFlags

Default algorithm-specific compression/decompression flags.

See also: TFlags, EMethod

Enumerator fDefault

Use algorithm-specific defaults.

Definition at line 129 of file stream_util.hpp.

◆ EDeleteProcessor

If to delete the used compression processor in the destructor.

Enumerator eDelete

Do delete processor object.

eNoDelete

Do not delete processor object.

Definition at line 210 of file stream.hpp.

◆ EDirection

Stream processing direction.

Enumerator eRead

Reading from stream.

eWrite

Writing into stream.

eReadWrite

eRead + eWrite

Definition at line 117 of file stream.hpp.

◆ EMethod

Compression/decompression methods.

Note: Don't mix up "eNone" with CCompress::eLevel_NoCompression compression level. In "eNone" mode data will be copied "as is", without parsing or writing any header or footer. CCompress::eLevel_NoCompression use no-compression for a choosen compression format and can have extra data necessary to be valid,; You can use "eNone" to allow transparent reading/writing data from/to an underlying stream using compression streams, but we do not recommend this. It is always better to use direct access to the original input/output stream if you know in advance that data is uncompressed.

Enumerator eNone

no compression method (copy "as is")

eBZip2

BZIP2.

eLZO

LZO (LZO1X)

eZip

ZLIB (raw zip data / DEFLATE method)

eGZipFile

.gz file (including concatenated files)

eConcatenatedGZipFile

Synonym for eGZipFile (for backward compatibility) - deprecated.

eZipCloudflare

ZLIB (raw zip data / DEFLATE method) Cloudflare fork.

eGZipCloudflareFile

.gz file (including concatenated files) Cloudflare fork

eZstd

ZStandard (raw zstd data)

Definition at line 98 of file stream_util.hpp.

◆ EOwnership

Which of the objects (passed in the constructor) should be deleted on this object's destruction.

NOTE: if the reader and writer are in fact one object, it will not be deleted twice.

Enumerator fOwnStream

Delete the underlying I/O stream.

fOwnReader

Delete the reader.

fOwnWriter

Delete the writer.

fOwnProcessor fOwnAll

Definition at line 127 of file stream.hpp.

◆ EState

Stream processor state.

Enumerator eInit

Init() is done, but no data to process.

eActive

Processor ready to read/write.

eFinalize

Finalize() already done, but End() not yet.

eDone

End() done, processor cannot process data.

Definition at line 216 of file stream.hpp.

◆ _Xsgetn_s() virtual streamsize CCompressionStreambuf::_Xsgetn_s ( CT_CHAR_TYPE * buf, size_t , streamsize n ) inlineprotectedvirtual ◆ AllowEmptyData() virtual bool CTransparentProcessor::AllowEmptyData ( ) const inlinevirtual

Return TRUE if fAllowEmptyData flag is set for this compression.

Note: Used by stream buffer, that don't have access to specific compression implementation flags. So this method should be implemented in each processor.

Implements CCompressionProcessor.

Definition at line 514 of file stream.hpp.

◆ CCompressionIOStream() [1/2] ◆ CCompressionIOStream() [2/2] CCompressionIOStream::CCompressionIOStream ( void ) inlineprotected

Default constructor.

Default constructor allow to create stream with specific characteristics later, not necessary in the constructor. Can be used in derived classes.

See also: CCompressionStream, Create()

Definition at line 494 of file stream.hpp.

◆ CCompressionIStream() [1/2] ◆ CCompressionIStream() [2/2] CCompressionIStream::CCompressionIStream ( void ) inlineprotected

Default constructor.

Default constructor allow to create stream with specific characteristics later. Can be used in derived classes.

See also: CCompressionStream, Create()

Definition at line 328 of file stream.hpp.

◆ CCompressionOStream() [1/2] ◆ CCompressionOStream() [2/2] CCompressionOStream::CCompressionOStream ( void ) inlineprotected

Default constructor.

Default constructor allow to create stream with specific characteristics later, not necessary in the constructor. Can be used in derived classes.

See also: CCompressionStream, Create()

Definition at line 409 of file stream.hpp.

◆ CCompressionStream() [1/3] ◆ CCompressionStream() [2/3]

Private copy constructor to prohibit copy.

◆ CCompressionStream() [3/3] CCompressionStream::CCompressionStream ( void ) protected

Default constructor.

Default constructor allow to create stream with specific characteristics later, not necessary in the constructor. Can be used in derived classes.

See also: Create()

Definition at line 116 of file stream.cpp.

◆ CCompressionStreambuf()

Definition at line 57 of file streambuf.cpp.

References CT_CHAR_TYPE, AutoArray< X, Del >::get(), CCompressionStreamProcessor::Init(), CCompressionStreamProcessor::m_Begin, CCompressionStreambuf::m_Buf, CCompressionStreamProcessor::m_End, CCompressionStreamProcessor::m_InBuf, CCompressionStreamProcessor::m_InBufSize, CCompressionStreamProcessor::m_OutBuf, CCompressionStreamProcessor::m_OutBufSize, CCompressionStreamProcessor::m_Processor, CCompressionStreambuf::m_Reader, CCompressionStreambuf::m_Writer, and AutoArray< X, Del >::release().

◆ CCompressionStreamProcessor() [1/2] ◆ CCompressionStreamProcessor() [2/2]

Private copy constructor to prohibit copy.

◆ CCompressIStream()

Create an input stream that compresses data read from an underlying input stream.

Reading from CCompressIStream results in data being read from an underlying "stream", compressed using the specified "method" and algorithm-specific "flags", and returned to the calling code in compressed form.

Parameters: stream The underlying input stream. NOTE: This stream should be opened in binary mode! method The method to use for data compression. flags By default, predefined algorithm-specific flags will be used, but they can be overridden by using this parameter. level Compression level. own_istream If set to eTakeOwnership then the 'stream' will be owned by CCompressIStream and automatically deleted when necessary.

Definition at line 243 of file stream_util.cpp.

References CCompressionIStream::Create(), eCompress, eTakeOwnership, CCompressionStream::fOwnAll, CCompressionStream::fOwnProcessor, and s_Init().

◆ CCompressOStream()

Create an output stream that compresses data written to it.

Writing to CCompressOStream results in the data written by the calling code being compressed using the specified "method" and algorithm-specific "flags", and written to an underlying "stream" in compressed form.

Parameters: stream The underlying output stream. NOTE: This stream should be opened in binary mode! method The method to use for data compression. flags By default, predefined algorithm-specific flags will be used, but they can be overridden by using this parameter. level Compression level. own_ostream If set to eTakeOwnership then the 'stream' will be owned by CCompressOStream and automatically deleted when necessary.

Definition at line 257 of file stream_util.cpp.

References CCompressionOStream::Create(), eCompress, eTakeOwnership, CCompressionStream::fOwnAll, CCompressionStream::fOwnProcessor, and s_Init().

◆ CDecompressIStream()

Create an input stream that decompresses data read from an underlying input stream.

Reading from CDecompressIStream results in data being read from an underlying "stream", decompressed using the specified "method" and algorithm-specific "flags", and returned to the calling code in decompressed form.

Parameters: stream The underlying input stream, having compressed data. NOTE: This stream should be opened in binary mode! method The method to use for data decompression. flags By default, predefined algorithm-specific flags will be used, but they can be overridden by using this parameter. own_istream If set to eTakeOwnership then the 'stream' will be owned by CDecompressIStream and automatically deleted when necessary.

Definition at line 271 of file stream_util.cpp.

References CCompressionIStream::Create(), eDecompress, ICompression::eLevel_Default, eTakeOwnership, CCompressionStream::fOwnAll, CCompressionStream::fOwnProcessor, and s_Init().

◆ CDecompressOStream() ◆ CManipulatorIProxy()

template<class TInputStream , class TOutputStream >

◆ CManipulatorOProxy()

template<class TInputStream , class TOutputStream >

◆ Create() [1/5]

Define this method to avoid compiler warnings only.

◆ Create() [2/5]

Define this method to avoid compiler warnings only.

◆ Create() [3/5]

Create stream with specific characteristics later, not necessary in the constructor.

Do nothing, if stream is already initialized.

Definition at line 123 of file stream.cpp.

References init(), CCompressionStreambuf::IsOkay(), CCompressionStream::m_Ownership, CCompressionStream::m_Reader, CCompressionStream::m_Stream, CCompressionStream::m_StreamBuf, and CCompressionStream::m_Writer.

Referenced by CCompressionStream::CCompressionStream(), CCompressionIStream::Create(), and CCompressionOStream::Create().

◆ Create() [4/5] ◆ Create() [5/5] ◆ CTransparentProcessor() CTransparentProcessor::CTransparentProcessor ( void ) inline

Definition at line 512 of file stream.hpp.

◆ CTransparentStreamProcessor() [1/2] CTransparentStreamProcessor::CTransparentStreamProcessor ( streamsize in_bufsize, streamsize out_bufsize ) inline ◆ CTransparentStreamProcessor() [2/2] CTransparentStreamProcessor::CTransparentStreamProcessor ( void ) inline

Conventional constructor.

Definition at line 550 of file stream.hpp.

◆ End() ◆ Finalize() [1/4] ◆ Finalize() [2/4] ◆ Finalize() [3/4] ◆ Finalize() [4/4] ◆ Finish() [1/2] ◆ Finish() [2/2] ◆ Flush() [1/2]

Definition at line 244 of file streambuf.cpp.

References _VERIFY, buf, CSP, CT_CHAR_TYPE, CCompressionStream::eRead, CCompressionStream::eWrite, CCompressionStreambuf::GetStreamProcessor(), THROW_FAILURE, and CCompressionStreambuf::WriteOutBufToStream().

Referenced by CCompressionStreambuf::Finish(), CCompressionStreambuf::ProcessStreamRead(), CCompressionStreambuf::ProcessStreamWrite(), and CCompressionStreambuf::Sync().

◆ Flush() [2/2] ◆ g_GetManipulatorError()

template<class T >

string g_GetManipulatorError ( T & stream ) ◆ GetCompressionProcessor() ◆ GetError() [1/3] ◆ GetError() [2/3] bool CCompressionIStream::GetError ( int & status, string & description ) inline ◆ GetError() [3/3] bool CCompressionOStream::GetError ( int & status, string & description ) inline ◆ GetOutputSize() [1/3] ◆ GetOutputSize() [2/3] size_t CCompressionIStream::GetOutputSize ( void ) inline ◆ GetOutputSize() [3/3] size_t CCompressionOStream::GetOutputSize ( void ) inline ◆ GetProcessedSize() [1/3] ◆ GetProcessedSize() [2/3] size_t CCompressionIStream::GetProcessedSize ( void ) inline ◆ GetProcessedSize() [3/3] size_t CCompressionOStream::GetProcessedSize ( void ) inline ◆ GetProcessor() ◆ GetStatus() [1/3] ◆ GetStatus() [2/3] ◆ GetStatus() [3/3] ◆ GetStreamProcessor() ◆ HaveSupport()

Check if specified compression method is supported on a current platform.

Compression streams can be created for any method. It ignores the fact that some compression library can be missed on a current platform, that lead to a throwing an exception on usage of the newly created stream. It is recommended to guard library-specific code by HAVE_LIB* macros (see comments at the beginning of "compress.hpp"), at least for eLZO and eZstd. But if this is inconvenient for some reason you can use this method to do a check at runtime.

Parameters

Returns: Return TRUE if selected compression method is supported, FALSE otherwise.

Definition at line 58 of file stream_util.cpp.

References CCompressStream::eBZip2, CCompressStream::eConcatenatedGZipFile, CCompressStream::eGZipCloudflareFile, CCompressStream::eGZipFile, CCompressStream::eLZO, CCompressStream::eNone, CCompressStream::eZip, CCompressStream::eZipCloudflare, and CCompressStream::eZstd.

◆ Init() [1/2] void CCompressionStreamProcessor::Init ( void )

(Re)Initialize stream processor.

Definition at line 81 of file stream.cpp.

References CCompressionStreamProcessor::eDone, CCompressionStreamProcessor::eInit, CCompressionProcessor::End(), CCompressionProcessor::eStatus_Success, CCompressionProcessor::Init(), CCompressionStreamProcessor::m_Begin, CCompressionStreamProcessor::m_End, CCompressionStreamProcessor::m_InBuf, CCompressionStreamProcessor::m_LastStatus, CCompressionStreamProcessor::m_OutBuf, CCompressionStreamProcessor::m_Processor, and CCompressionStreamProcessor::m_State.

Referenced by CCompressionStreambuf::CCompressionStreambuf().

◆ Init() [2/2] ◆ IsOkay() [1/2] bool CCompressionStreamProcessor::IsOkay ( void ) const inline ◆ IsOkay() [2/2] bool CCompressionStreambuf::IsOkay ( void ) const inline ◆ IsStreamProcessorHaveData() ◆ IsStreamProcessorOkay() ◆ operator<<() [1/20] void CCompressionIStream::operator<< ( bool ) const private

Disable operator<<(bool)

◆ operator<<() [2/20]

template<class TInputStream , class TOutputStream >

◆ operator<<() [3/20]

template<class TInputStream , class TOutputStream >

Disable using output stream as parameter for manipulator.

◆ operator<<() [4/20]

template<class TInputStream , class TOutputStream >

◆ operator<<() [5/20]

template<class TInputStream , class TOutputStream >

◆ operator<<() [6/20] ◆ operator<<() [7/20] ◆ operator<<() [8/20] ◆ operator<<() [9/20] ◆ operator<<() [10/20] ◆ operator<<() [11/20] ◆ operator<<() [12/20] ◆ operator<<() [13/20] ◆ operator<<() [14/20] ◆ operator<<() [15/20] ◆ operator<<() [16/20] ◆ operator<<() [17/20] ◆ operator<<() [18/20] ◆ operator<<() [19/20] ◆ operator<<() [20/20] ◆ operator=() [1/2]

Private assignment operator to prohibit assignment.

◆ operator=() [2/2]

Private assignment operator to prohibit assignment.

◆ operator>>() [1/19] void CCompressionOStream::operator>> ( bool ) const private

Disable operator>>(bool)

◆ operator>>() [2/19]

template<class TInputStream , class TOutputStream >

Disable using input stream as parameter for manipulator.

◆ operator>>() [3/19]

template<class TInputStream , class TOutputStream >

◆ operator>>() [4/19] ◆ operator>>() [5/19] ◆ operator>>() [6/19] ◆ operator>>() [7/19] ◆ operator>>() [8/19] ◆ operator>>() [9/19] ◆ operator>>() [10/19] ◆ operator>>() [11/19] ◆ operator>>() [12/19] ◆ operator>>() [13/19] ◆ operator>>() [14/19] ◆ operator>>() [15/19] ◆ operator>>() [16/19] ◆ operator>>() [17/19] ◆ operator>>() [18/19] ◆ operator>>() [19/19]

template<class TInputStream , class TOutputStream >

◆ overflow() ◆ Process() [1/2] ◆ Process() [2/2] ◆ ProcessStreamRead() bool CCompressionStreambuf::ProcessStreamRead ( void ) protected

Definition at line 362 of file streambuf.cpp.

Referenced by CCompressionStreambuf::Process(), CCompressionStreambuf::underflow(), and CCompressionStreambuf::xsgetn().

◆ ProcessStreamWrite() bool CCompressionStreambuf::ProcessStreamWrite ( void ) protected

Definition at line 447 of file streambuf.cpp.

References count, CCompressionStream::eWrite, CCompressionStreambuf::Flush(), CCompressionStreamProcessor::m_End, CCompressionStreamProcessor::m_LastStatus, CCompressionStreamProcessor::m_OutBuf, CCompressionStreamProcessor::m_OutBufSize, CCompressionStreamProcessor::m_Processor, CCompressionStreamProcessor::m_State, CCompressionStreambuf::m_Writer, CCompressionProcessor::Process(), THROW_FAILURE, and CCompressionStreambuf::WriteOutBufToStream().

Referenced by CCompressionStreambuf::overflow(), CCompressionStreambuf::Process(), and CCompressionStreambuf::xsputn().

◆ Read() [1/2] size_t CCompressionIStream::Read ( void * buf, size_t len )

Auxiliary method to read from stream.

Read up to "len" bytes from the stream into the buffer "buf". Returning value less than "n" mean EOF or error, check stream state bits for details.

Note: Allow to read more than 4GB, that regular read() cannot handle on some platforms.

Definition at line 245 of file stream.cpp.

References buf, kMax, len, max(), and n.

◆ Read() [2/2] size_t CCompressionIOStream::Read ( void * buf, size_t len )

Auxiliary method to read from stream.

Read up to "len" bytes from the stream into the buffer "buf". Returning value less than "n" mean EOF or error, check stream state bits for details.

Note: Allow to read more than 4GB, that regular read() cannot handle on some platforms.

Definition at line 283 of file stream.cpp.

References buf, kMax, len, max(), and n.

◆ setbuf() streambuf * CCompressionStreambuf::setbuf ( CT_CHAR_TYPE * buf, streamsize buf_size ) inlineprotectedvirtual ◆ Sync() ◆ sync() int CCompressionStreambuf::sync ( void ) protectedvirtual ◆ underflow() ◆ Write() [1/2] size_t CCompressionOStream::Write ( const void * buf, size_t len )

Auxiliary method to write into stream.

Write up "len" bytes from the buffer "buf" into the stream. Returning value less than "n" mean error, check stream state bits for details.

Note: Allow to write more than 4GB, that regular write() cannot handle on some platforms.

Definition at line 263 of file stream.cpp.

References buf, kMax, len, max(), and n.

◆ Write() [2/2] size_t CCompressionIOStream::Write ( const void * buf, size_t len )

Auxiliary method to write into stream.

Write up "len" bytes from the buffer "buf" into the stream. Returning value less than "n" mean error, check stream state bits for details.

Note: Allow to write more than 4GB, that regular write() cannot handle on some platforms.

Definition at line 301 of file stream.cpp.

References buf, kMax, len, max(), and n.

◆ WriteOutBufToStream() bool CCompressionStreambuf::WriteOutBufToStream ( bool force_write = false ) protected ◆ x_GetError() ◆ x_GetOutputSize() ◆ x_GetProcessedSize() ◆ x_GetStatus() ◆ xsgetn() streamsize CCompressionStreambuf::xsgetn ( CT_CHAR_TYPE * buf, streamsize n ) protectedvirtual

Definition at line 566 of file streambuf.cpp.

References CCompressionProcessor::AllowEmptyData(), buf, count, done, CCompressionStreambuf::IsOkay(), CCompressionStreamProcessor::m_OutBuf, CCompressionStreamProcessor::m_Processor, CCompressionStreambuf::m_Reader, min(), CCompressionStreambuf::ProcessStreamRead(), and THROW_FAILURE.

Referenced by CCompressionStreambuf::_Xsgetn_s().

◆ xsputn() streamsize CCompressionStreambuf::xsputn ( const CT_CHAR_TYPE * buf, streamsize count ) protectedvirtual ◆ ~CCompressionStream() CCompressionStream::~CCompressionStream ( void ) virtual ◆ ~CCompressionStreambuf() CCompressionStreambuf::~CCompressionStreambuf ( void ) virtual

Definition at line 114 of file streambuf.cpp.

References COMPRESS_HANDLE_EXCEPTIONS, CSP, CCompressionStream::eRead, ERR_COMPRESS, CCompressionStream::eWrite, CCompressionStreambuf::Finalize(), CCompressionStreambuf::GetStreamProcessor(), CCompressionStreambuf::IsStreamProcessorHaveData(), CCompressionStreambuf::m_Buf, msg_error, msg_overflow, msg_where, and CCompressionStreambuf::WriteOutBufToStream().

◆ ~CCompressionStreamProcessor() CCompressionStreamProcessor::~CCompressionStreamProcessor ( void ) virtual ◆ ~CTransparentProcessor() CTransparentProcessor::~CTransparentProcessor ( void ) virtual ◆ m_Begin ◆ m_Buf ◆ m_End ◆ m_InBuf ◆ m_InBufSize streamsize CCompressionStreamProcessor::m_InBufSize private ◆ m_LastStatus ◆ m_Method [1/2]

template<class TInputStream , class TOutputStream >

◆ m_Method [2/2]

template<class TInputStream , class TOutputStream >

◆ m_NeedDelete ◆ m_OutBuf ◆ m_OutBufSize streamsize CCompressionStreamProcessor::m_OutBufSize private ◆ m_Ownership ◆ m_Processor

(De)compression processor.

Definition at line 250 of file stream.hpp.

◆ m_Reader [1/2] ◆ m_Reader [2/2] ◆ m_State EState CCompressionStreamProcessor::m_State private ◆ m_Stream [1/4] ◆ m_Stream [2/4]

template<class TInputStream , class TOutputStream >

◆ m_Stream [3/4]

template<class TInputStream , class TOutputStream >

◆ m_Stream [4/4] CNcbiIos* CCompressionStreambuf::m_Stream protected ◆ m_StreamBuf ◆ m_Writer [1/2] ◆ m_Writer [2/2] ◆ CCompressionStream ◆ CCompressionStreambuf

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4