Struct StreamWriter 

pub struct StreamWriter<W: Write> { /* private fields */ }

A streaming writer for binary sequence data

This writer buffers data before writing it to the underlying writer, providing efficient streaming capabilities suitable for:

• Writing to network connections
• Processing very large datasets
• Pipeline processing

The StreamWriter is a specialized version of Writer that adds internal buffering and is optimized for streaming scenarios.

Implementations

impl<W: Write> StreamWriter<W>

pub fn new( inner: W, header: FileHeader, policy: Policy, headless: bool, ) -> Result<Self>

Creates a new StreamWriter with the default buffer size

This constructor initializes a StreamWriter with an 8K buffer for efficient writing to the underlying writer.

Arguments

• inner - The writer to write binary sequence data to
• header - The header defining sequence lengths and format
• policy - The policy for handling invalid nucleotides
• headless - Whether to skip writing the header

Returns

• Ok(StreamWriter) - A new streaming writer
• Err(Error) - If initialization fails

pub fn with_capacity( inner: W, capacity: usize, header: FileHeader, policy: Policy, headless: bool, ) -> Result<Self>

Creates a new StreamWriter with a specified buffer capacity

This constructor allows customizing the buffer size based on expected usage patterns and performance requirements.

Arguments

• inner - The writer to write binary sequence data to
• capacity - The size of the internal buffer in bytes
• header - The header defining sequence lengths and format
• policy - The policy for handling invalid nucleotides
• headless - Whether to skip writing the header

Returns

• Ok(StreamWriter) - A new streaming writer with the specified buffer capacity
• Err(Error) - If initialization fails

pub fn write_record( &mut self, flag: Option<u64>, primary: &[u8], ) -> Result<bool>

👎Deprecated:

use push method with SequencingRecord instead

pub fn write_paired_record( &mut self, flag: Option<u64>, primary: &[u8], extended: &[u8], ) -> Result<bool>

👎Deprecated:

use push method with SequencingRecord instead

pub fn push(&mut self, record: SequencingRecord<'_>) -> Result<bool>

Writes a record using the unified SequencingRecord API

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

Flushes any buffered data to the underlying writer

Returns

• Ok(()) - If the flush was successful
• Err(Error) - If flushing failed

pub fn into_inner(self) -> Result<W>

Consumes the streaming writer and returns the inner writer after flushing

This method is useful when you need access to the underlying writer after all writing is complete.

Returns

• Ok(W) - The inner writer after flushing all data
• Err(Error) - If flushing failed