Struct Builder

pub struct Builder { /* private fields */ }

An indexed SAM reader builder.

Implementations

impl Builder

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

where I: BinningIndex + 'static,

Sets an index.

Examples

use noodles_csi as csi;
use noodles_sam::io::indexed_reader::Builder;

let index = csi::Index::default();
let builder = Builder::default().set_index(index);

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

where P: AsRef<Path>,

Builds an indexed SAM reader from a path.

Examples

use noodles_sam::io::indexed_reader::Builder;
let reader = Builder::default().build_from_path("sample.sam.gz")?;

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

where R: Read,

Builds a indexed SAM reader from a reader.

Examples

use noodles_csi as csi;
use noodles_sam::io::indexed_reader::Builder;

let index = csi::Index::default();
let reader = Builder::default().set_index(index).build_from_reader(io::empty())?;

Trait Implementations

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.