Struct BamReader 

pub struct BamReader<'r> { /* private fields */ }

[this reader was autogenerated via macro]

Implementations

impl<'r> BamReader<'r>

pub fn new<B>(data: B, params: Option<()>) -> Result<Self, EtError>

where B: TryInto<ReadBuffer<'r>>, EtError: From<<B as TryInto<ReadBuffer<'r>>>::Error>,

Create a new instance of the reader

Errors

If data could not be turned into a ReadBuffer successfully or if the initial state could not be extracted, returns an EtError.

pub fn next(&mut self) -> Result<Option<BamRecord<'_>>, EtError>

Return the specialized version of this record.

To get the “generic” version, please use the next_record method from the RecordReader trait.

Errors

If a value could not be extracted, return an EtError.

Trait Implementations

impl<'r> Debug for BamReader<'r>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'r> RecordReader for BamReader<'r>

fn next_record(&mut self) -> Result<Option<Vec<Value<'_>>>, EtError>

The next record, expressed as a Vec of Values.

fn headers(&self) -> Vec<String>

The headers for this Reader.

fn metadata(&self) -> BTreeMap<String, Value<'_>>

The metadata for this Reader.