Struct DryIceWriter 

pub struct DryIceWriter<W, S: SequenceCodec = RawAsciiCodec, Q: QualityCodec = RawQualityCodec, N: NameCodec = RawNameCodec, K = NoRecordKey> { /* private fields */ }

Writes sequencing records into the dryice block-oriented format.

Implementations

impl DryIceWriter<MissingInner, RawAsciiCodec, RawQualityCodec, RawNameCodec, NoRecordKey>

pub fn builder() -> DryIceWriterBuilder<MissingInner, RawAsciiCodec, RawQualityCodec, RawNameCodec, NoRecordKey>

Start building a new writer.

impl<W: Write, S: SequenceCodec, Q: QualityCodec, N: NameCodec> DryIceWriter<W, S, Q, N, NoRecordKey>

pub fn from_options( inner: W, options: &DryIceWriterOptions, ) -> Result<Self, DryIceError>

Create an unkeyed writer from a pre-built options struct.

Errors

Returns an error if the options request an unsupported block-size policy.

pub fn options(&self) -> DryIceWriterOptions

Assemble the current configuration into an options struct.

pub fn write_record<R: SeqRecordLike>( &mut self, record: &R, ) -> Result<(), DryIceError>

Write a single sequencing record to an unkeyed writer.

Errors

Returns an error if the record fails validation, if the file header cannot be written, or if flushing the current block fails.

impl<W: Write, S: SequenceCodec, Q: QualityCodec, N: NameCodec, K: RecordKey> DryIceWriter<W, S, Q, N, K>

pub fn write_record_with_key<R: SeqRecordLike>( &mut self, record: &R, key: &K, ) -> Result<(), DryIceError>

Write a single sequencing record together with its accelerator key.

Errors

Returns an error if the record fails validation, if the key cannot be encoded, if the file header cannot be written, or if flushing the current block fails.

pub fn write_key_only(&mut self, key: &K) -> Result<(), DryIceError>

Write a key-only record with empty payload fields.

Errors

Returns an error if the file header cannot be written, if the key cannot be encoded, or if flushing the current block fails.

impl<W: Write, S: SequenceCodec, Q: QualityCodec, N: NameCodec, K> DryIceWriter<W, S, Q, N, K>

pub fn finish(self) -> Result<W, DryIceError>

Flush any remaining buffered records and finalize the file.

Errors

Returns an error if writing the file header or flushing the final block fails.