Struct noodles_bcf::async::io::Writer

source ·

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

Expand description

An async BCF writer.

Implementations§

source §

impl<W> Writer<W>
where W: AsyncWrite + Unpin,

source

pub fn get_ref(&self) -> &W

Returns a reference to the underlying writer.

§Examples

use noodles_bcf as bcf;
let writer = bcf::r#async::io::Writer::from(io::sink());
let _inner = writer.get_ref();

source

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

Returns a mutable reference to the underlying writer.

§Examples

use noodles_bcf as bcf;
let mut writer = bcf::r#async::io::Writer::from(io::sink());
let _inner = writer.get_mut();

source

pub fn into_inner(self) -> W

Returns the underlying writer.

§Examples

use noodles_bcf as bcf;
let writer = bcf::r#async::io::Writer::from(io::sink());
let _inner = writer.into_inner();

source

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

Writes a VCF header.

§Examples

use noodles_bcf as bcf;
use noodles_vcf as vcf;

let mut writer = bcf::r#async::io::Writer::new(io::sink());

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

source

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

Writes a record.

§Examples

use noodles_bcf as bcf;
use noodles_vcf::{self as vcf, header::StringMaps};

let mut writer = bcf::r#async::io::Writer::new(io::sink());

let mut header = vcf::Header::builder()
    .add_contig("sq0", Default::default())
    .build();
*header.string_maps_mut() = StringMaps::try_from(&header)?;

writer.write_header(&header).await?;

let record = bcf::Record::default();
writer.write_record(&header, &record).await?;

source

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

Writes a variant record.

§Examples

use noodles_bcf as bcf;
use noodles_core::Position;
use noodles_vcf as vcf;

let mut writer = bcf::r#async::io::Writer::new(io::sink());

let header = vcf::Header::builder()
    .add_contig("sq0", Default::default())
    .build();

writer.write_header(&header).await?;

let record = vcf::variant::RecordBuf::builder()
    .set_reference_sequence_name("sq0")
    .set_variant_start(Position::MIN)
    .set_reference_bases("A")
    .build();

writer.write_variant_record(&header, &record).await?;