Struct Builder

pub struct Builder { /* private fields */ }

A SAM writer builder.

Implementations

impl Builder

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

Sets the compression method.

Examples

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

pub fn build_from_path<P>(self, dst: P) -> Result<Writer<Box<dyn Write>>>

where P: AsRef<Path>,

Builds a SAM writer from a path.

If the compression method is not set, it is detected from the path extension.

Examples

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

pub fn build_from_writer<'w, W>(self, writer: W) -> Writer<Box<dyn Write + 'w>>

where W: Write + 'w,

Builds a SAM writer from a writer.

If the compression method is not set, no compression is used.

Examples

use noodles_sam::io::writer::Builder;
let writer = Builder::default().build_from_writer(io::sink());

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.