Struct DryIceReader 

pub struct DryIceReader<R, S = RawAsciiCodec, Q = RawQualityCodec, N = RawNameCodec, K = NoRecordKey> { /* private fields */ }

Reads sequencing records from a dryice file.

Implementations

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

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

Start building a new reader.

impl<R: Read> DryIceReader<R, RawAsciiCodec, RawQualityCodec, RawNameCodec, NoRecordKey>

pub fn new(inner: R) -> Result<Self, DryIceError>

Open a dryice file for reading with default codecs.

Errors

Returns an error if the file header is missing, corrupt, or uses an unsupported format version.

pub fn with_two_bit_exact( inner: R, ) -> Result<DryIceReader<R, TwoBitExactCodec, RawQualityCodec, RawNameCodec, NoRecordKey>, DryIceError>

Open a reader configured for the built-in 2-bit exact sequence codec.

Errors

Returns an error if the file header is missing, corrupt, or uses an unsupported format version.

pub fn with_codecs<S: SequenceCodec, Q: QualityCodec, N: NameCodec>( inner: R, ) -> Result<DryIceReader<R, S, Q, N, NoRecordKey>, DryIceError>

Open a reader configured for user-defined codecs.

Errors

Returns an error if the file header is missing, corrupt, or uses an unsupported format version.

pub fn with_record_key<K2: RecordKey>( inner: R, ) -> Result<DryIceReader<R, RawAsciiCodec, RawQualityCodec, RawNameCodec, K2>, DryIceError>

Open a reader configured for a user-defined record-key type with default codecs.

Errors

Returns an error if the file header is missing, corrupt, or uses an unsupported format version.

pub fn with_bytes8_key( inner: R, ) -> Result<DryIceReader<R, RawAsciiCodec, RawQualityCodec, RawNameCodec, Bytes8Key>, DryIceError>

Open a reader configured for the built-in 8-byte key type.

Errors

Returns an error if the file header is missing, corrupt, or uses an unsupported format version.

pub fn with_bytes16_key( inner: R, ) -> Result<DryIceReader<R, RawAsciiCodec, RawQualityCodec, RawNameCodec, Bytes16Key>, DryIceError>

Open a reader configured for the built-in 16-byte key type.

Errors

Returns an error if the file header is missing, corrupt, or uses an unsupported format version.

impl<R: Read> DryIceReader<R>

pub fn open<S: SequenceCodec, Q: QualityCodec, N: NameCodec, K: RecordKey>( inner: R, ) -> Result<DryIceReader<R, S, Q, N, K>, DryIceError>

Open a reader with fully user-specified codec and key type parameters.

This is the most general constructor, intended for library authors who need to configure all four type parameters at once. Most users should prefer new, with_codecs, or the convenience constructors instead.

Errors

Returns an error if the file header is missing, corrupt, or uses an unsupported format version.

impl<R: Read, S: SequenceCodec, Q: QualityCodec, N: NameCodec, K: RecordKey> DryIceReader<R, S, Q, N, K>

pub fn record_key(&self) -> Result<K, DryIceError>

Decode the current record’s accelerator key.

Errors

Returns an error if no record key is present in the current block, if the configured key type does not match the block’s key metadata, or if the key bytes cannot be decoded into K.

pub fn next_key(&mut self) -> Result<Option<K>, DryIceError>

Advance to the next record and return only its key.

Errors

Returns an error if advancing to the next record fails or if the key section is missing or incompatible with K.

impl<R: Read, S: SequenceCodec, Q: QualityCodec, N: NameCodec, K> DryIceReader<R, S, Q, N, K>

pub fn next_record(&mut self) -> Result<bool, DryIceError>

Advance to the next record in the file.

Errors

Returns an error if a block header or block payload cannot be read or decoded, or if the block’s codec tags do not match the reader’s configured codecs.

pub fn into_records(self) -> DryIceRecords<R, S, Q, N, K>

Consume this reader into an iterator of owned SeqRecord values.

Trait Implementations

impl<R: Read, S: SequenceCodec, Q: QualityCodec, N: NameCodec, K> SeqRecordLike for DryIceReader<R, S, Q, N, K>

fn name(&self) -> &[u8]

The record name or identifier.

fn sequence(&self) -> &[u8]

The nucleotide sequence.

fn quality(&self) -> &[u8]

The per-base quality scores.

fn len(&self) -> usize

The length of the sequence.

fn is_empty(&self) -> bool

Whether the sequence is empty.