Struct noodles_bgzf::async::writer::Builder

pub struct Builder { /* private fields */ }

An async BGZF writer builder.

Implementations

impl Builder

pub fn set_compression_level(self, compression_level: CompressionLevel) -> Self

Sets a compression level.

By default, the compression level is set to level 6.

Examples

use noodles_bgzf::{self as bgzf, writer::CompressionLevel};

let builder = bgzf::r#async::writer::Builder::default()
    .set_compression_level(CompressionLevel::best());

pub fn set_worker_count(self, worker_count: NonZeroUsize) -> Self

Sets a worker count.

By default, the worker count is set to the number of available logical CPUs.

Examples

use std::num::NonZeroUsize;

use noodles_bgzf as bgzf;

let worker_count = NonZeroUsize::try_from(1)?;
let builder = bgzf::r#async::writer::Builder::default()
    .set_worker_count(worker_count);

pub fn build_with_writer<W>(self, writer: W) -> Writer<W>

where W: AsyncWrite,

Builds an async BGZF writer.

Examples

use noodles_bgzf as bgzf;
let writer = bgzf::r#async::writer::Builder::default()
    .build_with_writer(io::sink());

Trait Implementations

impl Debug for Builder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.