Struct Builder

pub struct Builder { /* private fields */ }

An indexed BAM reader builder.

Implementations

impl Builder

pub fn set_index<I>(self, index: I) -> Self

where I: BinningIndex + 'static,

Sets an index.

Examples

use noodles_bam::{bai, io::indexed_reader::Builder};
let index = bai::Index::default();
let builder = Builder::default().set_index(index);

pub fn build_from_path<P>(self, src: P) -> Result<IndexedReader<Reader<File>>>

where P: AsRef<Path>,

Builds an indexed BAM reader from a path.

If no index is set, this will attempt to read an associated index at <src>.bai or <src>.csi, in that order.

Examples

use noodles_bam::io::indexed_reader::Builder;
let reader = Builder::default().build_from_path("sample.bam")?;

pub fn build_from_reader<R>(self, reader: R) -> Result<IndexedReader<Reader<R>>>

where R: Read,

Builds an indexed BAM reader from a reader.

Examples

use noodles_bam::{bai, io::indexed_reader::Builder};
let index = bai::Index::default();
let data = [];
let reader = Builder::default().set_index(index).build_from_reader(&data[..])?;

Trait Implementations

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.