Spec GzFileStream
Allows to open gzip-compressed files.

Extends Stream
All Extended Stream
All Impl'd StreamConcept
Defined in <seqan/stream.h>
Signature template <> class Stream<GZFile>;

Member Function Overview

Interface Function Overview

Interface Functions Inherited From Stream

Interface Functions Inherited From StreamConcept

Interface Metafunction Overview

Interface Metafunctions Inherited From StreamConcept

Detailed Description

This is only available if SEQAN_HAS_ZLIB is set to 1.

Not copy constructable.

Member Functions Detail

Stream::Stream(); Stream::Stream(gzFile);

Constructor.

Parameters

gzFile A gzFile to wrap.

Remarks

When gzFile is given then the GZFileStream object does nto own the underlying gzFile and will serve as a simple wrapper. The underlying file is not closed when the GzFileStream object is destroyed.

Interface Functions Detail

bool isDirect(gzStream);

Query a GzFileStream for being "direct."

Parameters

gzStream The GzFileStream to query.

Returns

bool true indicates that the file is opened uncompressed ("direct").

Remarks

GzFileStream objects can also open uncompressed files (at a possible performance cost). Such functionality is provided directly by zlib.