Struct Builder

pub struct Builder { /* private fields */ }

An indexed CRAM reader builder.

Implementations

impl Builder

pub fn set_reference_sequence_repository( self, reference_sequence_repository: Repository, ) -> Self

Sets the reference sequence repository.

Examples

use noodles_cram::io::indexed_reader::Builder;
use noodles_fasta as fasta;

let reference_sequence_repository = fasta::Repository::default();
let builder = Builder::default()
    .set_reference_sequence_repository(reference_sequence_repository);

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

Sets an index.

Examples

use noodles_cram::{crai, io::indexed_reader::Builder};
let index = crai::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 CRAM reader from a path.

If no index is set, this will attempt to read an associated index at <src>.crai.

Examples

use noodles_cram::io::indexed_reader::Builder;
let builder = Builder::default().build_from_path("sample.cram")?;

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

where R: Read,

Builds an indexed CRAM reader from a reader.

Examples

use noodles_cram::{crai, io::indexed_reader::Builder};

let index = crai::Index::default();
let builder = 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.