Struct Builder

pub struct Builder { /* private fields */ }

A CRAM writer 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::writer::Builder;
use noodles_fasta as fasta;

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

pub fn preserve_read_names(self, value: bool) -> Self

Sets whether to preserve read names.

If false, read names are discarded.

The default is true.

Examples

use noodles_cram::io::writer::Builder;
let builder = Builder::default().preserve_read_names(false);

pub fn encode_alignment_start_positions_as_deltas(self, value: bool) -> Self

Sets whether to encode alignment start positions as deltas.

If false, record alignment start positions are written with their actual values.

The default is true.

Examples

use noodles_cram::io::writer::Builder;
let builder = Builder::default()
    .encode_alignment_start_positions_as_deltas(false);

pub fn set_block_content_encoder_map(self, map: BlockContentEncoderMap) -> Self

Sets the block content-encoder map.

Examples

use noodles_cram::{data_container::BlockContentEncoderMap, io::writer::Builder};

let block_content_encoder_map = BlockContentEncoderMap::default();
let builder = Builder::default()
    .set_block_content_encoder_map(block_content_encoder_map);

pub fn build_from_path<P>(self, dst: P) -> Result<Writer<File>>

where P: AsRef<Path>,

Builds a CRAM writer from a path.

Examples

use noodles_cram::io::writer::Builder;
let writer = Builder::default().build_from_path("out.cram")?;

pub fn build_with_path<P>(self, dst: P) -> Result<Writer<File>>

where P: AsRef<Path>,

👎Deprecated since 0.68.0: Use Builder::build_from_path instead.

Builds a CRAM writer from a path.

pub fn build_from_writer<W>(self, writer: W) -> Writer<W>

where W: Write,

Builds a CRAM writer from a writer.

Examples

use noodles_cram::io::writer::Builder;
let writer = Builder::default().build_from_writer(Vec::new());

pub fn build_with_writer<W>(self, writer: W) -> Writer<W>

where W: Write,

👎Deprecated since 0.68.0: Use Builder::build_from_writer instead.

Builds a CRAM writer from a writer.

Trait Implementations

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.