Struct rust_htslib::bcf::Reader

pub struct Reader { /* fields omitted */ }

A VCF/BCF reader.

Methods

impl Reader

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

Create a new reader from a given path.

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

Create a new reader from a given URL.

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

Create a new reader from standard input.

Trait Implementations

impl Read for Reader

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

Read the next record.

Important traits for Records<'a, R>

impl<'a, R: Read> Iterator for Records<'a, R> type Item = Result<Record, ReadError>;

fn records(&mut self) -> Records<Self>

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

fn set_threads(&mut self, n_threads: usize) -> Result<(), ThreadingError>

Activate multi-threaded BCF/VCF read support in htslib. This should permit faster reading of large VCF files.

fn header(&self) -> &HeaderView

Return the header.

fn empty_record(&self) -> Record

Return empty record. Can be reused multiple times.

impl Drop for Reader

fn drop(&mut self)

Executes the destructor for this type.

impl Send for Reader

impl Debug for Reader

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

Formats the value using the given formatter.