Struct rust_htslib::bcf::synced::SyncedReader

pub struct SyncedReader { /* fields omitted */ }

A wrapper for bcf_srs_t; allows joint traversal of multiple VCF and/or BCF files.

Implementations

impl SyncedReader

pub fn new() -> Result<Self>

pub fn set_require_index(&mut self, do_require: bool)

Enable or disable requiring of index

pub fn set_pairing(&mut self, bitmask: u32)

Set the given bitmask of values from sr_pairing module.

pub fn add_reader<P: AsRef<Path>>(&mut self, path: P) -> Result<()>

Add new reader with the path to the file.

pub fn remove_reader(&mut self, idx: u32)

Remove reader with the given index.

pub fn reader_count(&self) -> u32

Return number of open files/readers.

pub fn read_next(&mut self) -> Result<u32>

Read next line and return number of readers that have the given line (0 if end of all files is reached).

pub fn has_line(&self, idx: u32) -> bool

Return whether the given reader has the line.

pub fn record(&self, idx: u32) -> Option<Record>

Return record from the given reader, if any.

pub fn header(&self, idx: u32) -> &HeaderView

Return header from the given reader.

pub fn fetch(&mut self, rid: u32, start: u64, end: u64) -> Result<()>

Jump to the given region.

Arguments

• rid - numeric ID of the reference to jump to; use HeaderView::name2rid for resolving contig name to ID.
• start - 0-based start coordinate of region on reference.
• end - 0-based end coordinate of region on reference.

Trait Implementations

impl Debug for SyncedReader

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

Formats the value using the given formatter.

impl Drop for SyncedReader

fn drop(&mut self)

Executes the destructor for this type.