Struct noodles_sam::AsyncWriter
source · [−]pub struct AsyncWriter<W> where
W: AsyncWrite, { /* private fields */ }
Expand description
An async SAM writer.
Implementations
sourceimpl<W> Writer<W> where
W: AsyncWrite + Unpin,
impl<W> Writer<W> where
W: AsyncWrite + Unpin,
sourcepub fn new(inner: W) -> Self
pub fn new(inner: W) -> Self
Creates an async SAM writer.
Examples
use noodles_sam as sam;
let writer = sam::AsyncWriter::new(Vec::new());
sourcepub fn get_ref(&self) -> &W
pub fn get_ref(&self) -> &W
Returns a reference to the underlying writer.
Examples
use noodles_sam as sam;
let writer = sam::AsyncWriter::new(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_sam as sam;
let mut writer = sam::AsyncWriter::new(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_sam as sam;
let writer = sam::AsyncWriter::new(Vec::new());
assert!(writer.into_inner().is_empty());
sourcepub async fn write_header(&mut self, header: &Header) -> Result<()>
pub async fn write_header(&mut self, header: &Header) -> Result<()>
Writes a SAM header.
Examples
use noodles_sam as sam;
let mut writer = sam::AsyncWriter::new(Vec::new());
let header = sam::Header::builder().add_comment("noodles-sam").build();
writer.write_header(&header).await?;
assert_eq!(writer.get_ref(), b"@CO\tnoodles-sam\n");
sourcepub async fn write_record(&mut self, record: &Record) -> Result<()>
pub async fn write_record(&mut self, record: &Record) -> Result<()>
Writes a SAM record.
Examples
use noodles_sam as sam;
let mut writer = sam::AsyncWriter::new(Vec::new());
let record = sam::Record::default();
writer.write_record(&record).await?;
assert_eq!(writer.get_ref(), b"*\t4\t*\t0\t255\t*\t*\t0\t0\t*\t*\n");
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