Struct noodles_bcf::Writer

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

A BCF writer.

Implementations

impl<W> Writer<W> where
    W: Write, 

pub fn get_ref(&self) -> &W

Returns a reference to the underlying writer.

Examples

use noodles_bcf as bcf;
let writer = bcf::Writer::from(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_bcf as bcf;
let mut writer = bcf::Writer::from(Vec::new());
assert!(writer.get_mut().is_empty());

pub fn into_inner(self) -> W

Returns the underlying writer.

Examples

use noodles_bcf as bcf;
let mut writer = bcf::Writer::from(Vec::new());
assert!(writer.into_inner().is_empty());

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

Writes a BCF file format.

Examples

use noodles_bcf as bcf;
let mut writer = bcf::Writer::new(Vec::new());
writer.write_file_format()?;

pub 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::Writer::new(Vec::new());

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

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

Writes a record.

Examples

use noodles_bcf as bcf;
let mut writer = bcf::Writer::new(Vec::new());
let record = bcf::Record::default();
writer.write_record(&record)?;

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

Writes a VCF record.

Examples

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

let mut writer = bcf::Writer::new(Vec::new());

let header = vcf::Header::builder()
    .add_contig(Contig::new("sq0"))
    .build();

writer.write_header(&header)?;

let string_maps = StringMaps::from(&header);

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

writer.write_vcf_record(&header, &string_maps, &record)?;

impl<W> Writer<Writer<W>> where
    W: Write, 

pub fn new(writer: W) -> Self

Creates a BCF writer with a default compression level.

The given stream is wrapped in a BGZF encoder.

Examples

use noodles_bcf as bcf;
let writer = bcf::Writer::new(Vec::new());

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_bcf as bcf;
let mut writer = bcf::Writer::new(Vec::new());
writer.try_finish()?;

Trait Implementations

impl<W> From<W> for Writer<W>

fn from(inner: W) -> Self

Performs the conversion.