BgzfWriter

BGZF compression - this is a port of the original that used the undead.stream library.

struct BgzfWriter {

this(string fn, int _compression_level);

void throwBgzfException(string msg, string file, size_t line);

void enforce1(bool check, string msg, string file, int line);

void write(void* buf, size_t size);

void write(ubyte[] buf);

void write(string s);

void write(T value);

void flush_block();

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

void flush();

void close();

}

Constructors

this this(string fn, int _compression_level): Create new BGZF output stream with a multi-threaded writer

Destructor

~this ~this(): Undocumented in source.

Postblit

this(this) this(this): Undocumented in source.

Members

Functions

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. This function is automatically called on destruction.
enforce1 void enforce1(bool check, string msg, string file, int line): Undocumented in source. Be warned that the author may not have intended to support it.
flush void flush(): Flush all remaining BGZF blocks and underlying stream.
flush_block void flush_block(): Force flushing current block, even if it is not yet filled. Should also be used when it's not desired to have records crossing block borders.
setWriteHandler void setWriteHandler(void delegate(ubyte[], ubyte[]) handler): Undocumented in source. Be warned that the author may not have intended to support it.
throwBgzfException void throwBgzfException(string msg, string file, size_t line): Undocumented in source. Be warned that the author may not have intended to support it.
write void write(void* buf, size_t size): Undocumented in source. Be warned that the author may not have intended to support it.
write void write(ubyte[] buf): Undocumented in source. Be warned that the author may not have intended to support it.
write void write(string s): Undocumented in source. Be warned that the author may not have intended to support it.
write void write(T value): Undocumented in source. Be warned that the author may not have intended to support it.

Meta

Source

See Implementation

bio std experimental hts bgzf_writer aliases

BlockWriteHandler

functions

bgzfCompressFunc

structs

BgzfWriter