Struct rust_htslib::bcf::Reader

pub struct Reader { /* fields omitted */ }

A VCF/BCF reader.

Methods

impl Reader

fn from_path<P: AsRef<Path>>(path: P) -> Result<Self, BCFPathError>

Create a new reader from a given path.

fn from_url(url: &Url) -> Result<Self, BCFError>

Create a new reader from a given URL.

fn from_stdin() -> Result<Self, BCFError>

Create a new reader from standard input.

fn header(&self) -> &HeaderView

Get header of the read VCF/BCF file.

fn empty_record(&self) -> Record

Create empty record for this reader. The record can be reused multiple times.

fn read(&mut self, record: &mut Record) -> Result<(), ReadError>

Read the next record.

Arguments

• record - an empty record, that can be created with bcf::Reader::empty_record.

fn records(&mut self) -> Records

Return an iterator over all records of the VCF/BCF file.

Trait Implementations

impl Send for Reader

impl Drop for Reader

fn drop(&mut self)

Executes the destructor for this type.