[][src]Struct rust_htslib::bam::IndexedReader

pub struct IndexedReader { /* fields omitted */ }

Implementations

impl IndexedReader[src]

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

Create a new Reader from path.

Arguments

  • path - the path to open.

pub fn from_path_and_index<P: AsRef<Path>>(
    path: P,
    index_path: P
) -> Result<Self>
[src]

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

pub fn fetch(&mut self, tid: u32, beg: u64, end: u64) -> Result<()>[src]

pub fn fetch_str(&mut self, region: &[u8]) -> Result<()>[src]

Fetch reads from a region using a samtools region string. Region strings are of the format b"chr1:1-1000".

Arguments

  • region - A binary string

pub fn set_reference<P: AsRef<Path>>(&mut self, path: P) -> Result<()>[src]

Set the reference path for reading CRAM files.

Arguments

  • path - path to the FASTA reference

Trait Implementations

impl Debug for IndexedReader[src]

impl Drop for IndexedReader[src]

impl Read for IndexedReader[src]

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

Iterator over the records of the fetched region. Note that, while being convenient, this is less efficient than pre-allocating a Record and reading into it with the read method, since every iteration involves the allocation of a new Record.

impl Send for IndexedReader[src]

Auto Trait Implementations

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.