Struct Builder

pub struct Builder { /* private fields */ }

A SAM reader builder.

Implementations

impl Builder

pub fn set_compression_method( self, compression_method: CompressionMethod, ) -> Self

Sets the compression method.

Examples

use noodles_sam::io::{reader::Builder, CompressionMethod};
let builder = Builder::default().set_compression_method(CompressionMethod::Bgzf);

pub fn build_from_path<P>(self, src: P) -> Result<Reader<Box<dyn BufRead>>>

where P: AsRef<Path>,

Builds a SAM reader from a path.

By default, the compression method will be autodetected. This can be overridden by using Self::set_compression_method.

Examples

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

pub fn build_from_reader<'r, R>( self, reader: R, ) -> Result<Reader<Box<dyn BufRead + 'r>>>

where R: Read + 'r,

Builds a SAM reader from a reader.

Examples

use noodles_sam::io::reader::Builder;
let reader = Builder::default().build_from_reader(io::empty());

Trait Implementations

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.