Struct rust_htslib::bcf::Reader

source ·
pub struct Reader { /* private fields */ }
Expand description

A VCF/BCF reader.

Implementations§

source§

impl Reader

source

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

Create a new reader from a given path.

source

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

Create a new reader from a given URL.

source

pub fn from_stdin() -> Result<Self>

Create a new reader from standard input.

Trait Implementations§

source§

impl Debug for Reader

source§

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

Formats the value using the given formatter. Read more
source§

impl Drop for Reader

source§

fn drop(&mut self)

Executes the destructor for this type. Read more
source§

impl Read for Reader

source§

fn empty_record(&self) -> Record

Return empty record. Can be reused multiple times.

source§

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

Read the next record. Read more
source§

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

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

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

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

fn header(&self) -> &HeaderView

Return the header.
source§

impl Send for Reader

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.