Struct noodles_bam::writer::Writer
source · [−]pub struct Writer<W> { /* private fields */ }
Expand description
A BAM writer.
Examples
use noodles_bam as bam;
use noodles_sam::{self as sam, alignment::Record};
let mut writer = bam::Writer::new(Vec::new());
let header = sam::Header::default();
writer.write_header(&header)?;
writer.write_reference_sequences(header.reference_sequences())?;
let record = Record::default();
writer.write_record(&header, &record)?;
Implementations
sourceimpl<W> Writer<W> where
W: Write,
impl<W> Writer<W> where
W: Write,
sourcepub fn get_ref(&self) -> &W
pub fn get_ref(&self) -> &W
Returns a reference to the underlying writer.
Examples
use noodles_bam as bam;
let writer = bam::Writer::from(Vec::new());
assert!(writer.get_ref().is_empty());
sourcepub fn get_mut(&mut self) -> &mut W
pub fn get_mut(&mut self) -> &mut W
Returns a mutable reference to the underlying writer.
Examples
use noodles_bam as bam;
let mut writer = bam::Writer::from(Vec::new());
assert!(writer.get_mut().is_empty());
sourcepub fn into_inner(self) -> W
pub fn into_inner(self) -> W
Returns the underlying writer.
Examples
use noodles_bam as bam;
let writer = bam::Writer::from(Vec::new());
assert!(writer.into_inner().is_empty());
sourcepub fn write_header(&mut self, header: &Header) -> Result<()>
pub fn write_header(&mut self, header: &Header) -> Result<()>
Writes a SAM header.
Examples
use noodles_bam as bam;
use noodles_sam as sam;
let mut writer = bam::Writer::new(Vec::new());
let header = sam::Header::builder().add_comment("noodles-bam").build();
writer.write_header(&header)?;
sourcepub fn write_reference_sequences(
&mut self,
reference_sequences: &ReferenceSequences
) -> Result<()>
pub fn write_reference_sequences(
&mut self,
reference_sequences: &ReferenceSequences
) -> Result<()>
Writes SAM reference sequences.
The reference sequences here are typically the same as the reference sequences in the SAM header.
Examples
use noodles_bam as bam;
use noodles_sam::{self as sam, header::ReferenceSequence};
let mut writer = bam::Writer::new(Vec::new());
let header = sam::Header::builder()
.add_reference_sequence(ReferenceSequence::new("sq0".parse()?, 8)?)
.add_comment("noodles-bam")
.build();
writer.write_header(&header)?;
writer.write_reference_sequences(header.reference_sequences())?;
sourcepub fn write_record(&mut self, header: &Header, record: &Record) -> Result<()>
pub fn write_record(&mut self, header: &Header, record: &Record) -> Result<()>
Writes a BAM record.
Examples
use noodles_bam as bam;
use noodles_sam::{self as sam, alignment::Record};
let mut writer = bam::Writer::new(Vec::new());
let header = sam::Header::default();
let record = Record::default();
writer.write_record(&header, &record)?;
sourceimpl<W> Writer<Writer<W>> where
W: Write,
impl<W> Writer<Writer<W>> where
W: Write,
sourcepub fn new(writer: W) -> Self
pub fn new(writer: W) -> Self
Creates a BAM writer with a default compression level.
The given stream is wrapped in a BGZF encoder.
Examples
use noodles_bam as bam;
let writer = bam::Writer::new(Vec::new());
sourcepub fn try_finish(&mut self) -> Result<()>
pub fn try_finish(&mut self) -> Result<()>
Attempts to finish the output stream.
This is typically only manually called if the underlying stream is needed before the writer is dropped.
Examples
use noodles_bam as bam;
let mut writer = bam::Writer::new(Vec::new());
writer.try_finish()?;
Trait Implementations
sourceimpl<W> AlignmentWriter for Writer<W> where
W: Write,
impl<W> AlignmentWriter for Writer<W> where
W: Write,
Auto Trait Implementations
impl<W> RefUnwindSafe for Writer<W> where
W: RefUnwindSafe,
impl<W> Send for Writer<W> where
W: Send,
impl<W> Sync for Writer<W> where
W: Sync,
impl<W> Unpin for Writer<W> where
W: Unpin,
impl<W> UnwindSafe for Writer<W> where
W: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more