BgzfOutputStream

Class for BGZF compression

class BgzfOutputStream : Stream {

this(Stream output_stream, int compression_level, TaskPool task_pool, size_t buffer_size, size_t max_block_size, size_t block_size);

size_t readBlock(void* buffer, size_t size);

ulong seek(long offset, SeekPos whence);

size_t writeBlock(void* buf, size_t size);

void flushCurrentBlock();

void setWriteHandler(void delegate(ubyte[], ubyte[]) handler);

void flush();

void close();

void addEofBlock();

}

Constructors

this this(Stream output_stream, int compression_level, TaskPool task_pool, size_t buffer_size, size_t max_block_size, size_t block_size): Create new BGZF output stream which will use provided task_pool to do multithreaded compression.

Members

Functions

addEofBlock void addEofBlock(): Adds EOF block. This function is called in close() method.
close void close(): Flush all remaining BGZF blocks and close source stream. Automatically adds empty block at the end, serving as indicator of end of stream.
flush void flush(): Flush all remaining BGZF blocks and underlying stream.
flushCurrentBlock void flushCurrentBlock(): Force flushing current block, even if it is not yet filled. Should be used when it's not desired to have records crossing block borders.
readBlock size_t readBlock(void* buffer, size_t size): Undocumented in source. Be warned that the author may not have intended to support it.
seek ulong seek(long offset, SeekPos whence): Undocumented in source. Be warned that the author may not have intended to support it.
setWriteHandler void setWriteHandler(void delegate(ubyte[], ubyte[]) handler): Undocumented in source. Be warned that the author may not have intended to support it.
writeBlock size_t writeBlock(void* buf, size_t size): Undocumented in source. Be warned that the author may not have intended to support it.

Meta

Source

See Implementation

bio core bgzf outputstream aliases

BlockWriteHandler

classes

BgzfOutputStream

functions

bgzfCompressFunc