Struct noodles_vcf::AsyncWriter

pub struct AsyncWriter<W>
where
    W: AsyncWrite,
{ /* private fields */ }

An async VCF writer.

If the inner writer is buffered, a call to Self::shutdown must be made before the writer is dropped.

Implementations

impl<W> Writer<W>

where W: AsyncWrite + Unpin,

pub fn new(inner: W) -> Self

Creates an async VCF writer.

Examples

use noodles_vcf as vcf;
let writer = vcf::AsyncWriter::new(Vec::new());

pub fn get_ref(&self) -> &W

Returns a reference to the underlying writer.

Examples

use noodles_vcf as vcf;
let writer = vcf::AsyncWriter::new(Vec::new());
assert!(writer.get_ref().is_empty());

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

Returns a mutable reference to the underlying writer.

Examples

use noodles_vcf as vcf;
let mut writer = vcf::AsyncWriter::new(Vec::new());
assert!(writer.get_mut().is_empty());

pub fn into_inner(self) -> W

Returns the underlying writer.

Examples

use noodles_vcf as vcf;
let writer = vcf::AsyncWriter::new(Vec::new());
assert!(writer.into_inner().is_empty());

pub async fn shutdown(&mut self) -> Result<()>

Shuts down the output stream.

Examples

use noodles_vcf as vcf;
let mut writer = vcf::AsyncWriter::new(Vec::new());
writer.shutdown().await?;

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

Writes a VCF header.

Examples

use noodles_vcf as vcf;

let mut writer = vcf::AsyncWriter::new(Vec::new());

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

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

Writes a VCF record.

Examples

use noodles_vcf::{self as vcf, record::Position};

let record = vcf::Record::builder()
    .set_chromosome("sq0".parse()?)
    .set_position(Position::from(1))
    .set_reference_bases("A".parse()?)
    .build()?;

let mut writer = vcf::AsyncWriter::new(Vec::new());
writer.write_record(&record).await?;