Struct Writer

pub struct Writer<W> { /* private fields */ }

A CRAM writer.

A call to Self::try_finish must be made before the writer is dropped.

Examples

use noodles_cram as cram;
use noodles_sam::{self as sam, alignment::io::Write};

let mut writer = cram::io::Writer::new(io::sink());

let header = sam::Header::default();
writer.write_header(&header)?;

let record = sam::Record::default();
writer.write_alignment_record(&header, &record)?;

writer.try_finish(&header)?;

Implementations

impl<W> Writer<W>

pub fn get_ref(&self) -> &W

Returns a reference to the underlying writer.

Examples

use noodles_cram as cram;
let writer = cram::io::Writer::new(io::sink());
let _inner = writer.get_ref();

pub fn get_mut(&mut self) -> &mut W

Returns a mutable reference to the underlying writer.

Examples

use noodles_cram as cram;
let mut writer = cram::io::Writer::new(io::sink());
let _inner = writer.get_mut();

pub fn into_inner(self) -> W

Returns the underlying writer.

Examples

use noodles_cram as cram;
let mut writer = cram::io::Writer::new(io::sink());
let _inner = writer.into_inner();

impl<W> Writer<W>

where W: Write,

pub fn new(inner: W) -> Self

Creates a new CRAM writer with default options.

Examples

use noodles_cram as cram;
let writer = cram::io::Writer::new(io::sink());

pub fn try_finish(&mut self, header: &Header) -> Result<()>

Attempts to finish the output stream by writing any pending containers and a final EOF container.

This is typically only manually called if the underlying stream is needed before the writer is dropped.

Examples

use noodles_cram as cram;
use noodles_sam as sam;

let header = sam::Header::default();
let mut writer = cram::io::Writer::new(io::sink());
writer.try_finish(&header)?;

pub fn write_file_definition(&mut self) -> Result<()>

Writes a CRAM file definition.

The file ID is set as a blank value ([0x00; 20]).

Examples

use noodles_cram as cram;
let mut writer = cram::io::Writer::new(io::sink());
writer.write_file_definition()?;

pub fn write_file_header(&mut self, header: &Header) -> Result<()>

Writes a CRAM file header container.

The position of the stream is expected to be directly after the file definition.

Entries in the reference sequence dictionary that are missing MD5 checksums (M5) will automatically be calculated and added to the written record.

Examples

use noodles_cram as cram;
use noodles_sam as sam;

let mut writer = cram::io::Writer::new(io::sink());
writer.write_file_definition()?;

let header = sam::Header::default();
writer.write_file_header(&header)?;

writer.try_finish(&header)?;

pub fn write_header(&mut self, header: &Header) -> Result<()>

Writes a SAM header.

This writes the CRAM magic number, the file definition, and file header using the given SAM header.

use noodles_cram as cram;
use noodles_sam as sam;

let mut writer = cram::io::Writer::new(io::sink());

let header = sam::Header::default();
writer.write_header(&header)?;

pub fn write_record(&mut self, header: &Header, record: Record) -> Result<()>

Writes a CRAM record.

Examples

use noodles_cram as cram;
use noodles_sam::{self as sam, alignment::io::Write};

let mut writer = cram::io::Writer::new(io::sink());

let header = sam::Header::default();
writer.write_header(&header)?;

let record = sam::Record::default();
writer.write_alignment_record(&header, &record)?;

writer.try_finish(&header)?;

Trait Implementations

impl<W: Debug> Debug for Writer<W>

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

Formats the value using the given formatter.

impl<W> Write for Writer<W>

where W: Write,

fn write_alignment_header(&mut self, header: &Header) -> Result<()>

Writes a SAM header.

fn write_alignment_record( &mut self, header: &Header, record: &dyn Record, ) -> Result<()>

Writes an alignment record.

fn finish(&mut self, header: &Header) -> Result<()>

Shuts down an alignment writer.