Struct Builder

pub struct Builder<I> { /* private fields */ }

A binning index builder.

Implementations

impl<I> Builder<I>

where I: Index,

pub fn set_min_shift(self, min_shift: u8) -> Self

Sets a min shift.

Examples

use noodles_csi::{self as csi, BinningIndex};
let index = csi::Index::builder().set_min_shift(13).build();
assert_eq!(index.min_shift(), 13);

pub fn set_depth(self, depth: u8) -> Self

Sets a max depth.

Examples

use noodles_csi::{self as csi, BinningIndex};
let index = csi::Index::builder().set_depth(8).build();
assert_eq!(index.depth(), 8);

pub fn set_header(self, header: Header) -> Self

Sets a tabix header.

Examples

use noodles_csi::{self as csi, binning_index::index::Header, BinningIndex};
let header = Header::default();
let index = csi::Index::builder().set_header(header.clone()).build();
assert_eq!(index.header(), Some(&header));

pub fn set_reference_sequences( self, reference_sequences: Vec<ReferenceSequence<I>>, ) -> Self

Sets reference sequences.

Examples

use noodles_csi::{self as csi, binning_index::index::ReferenceSequence};

let reference_sequences = vec![ReferenceSequence::new(Default::default(), Default::default(), None)];
let index = csi::Index::builder()
    .set_reference_sequences(reference_sequences.clone())
    .build();

assert_eq!(index.reference_sequences(), &reference_sequences);

pub fn set_unplaced_unmapped_record_count( self, unplaced_unmapped_record_count: u64, ) -> Self

Sets an unplaced, unmapped record count.

Examples

use noodles_csi::{self as csi, BinningIndex};
let index = csi::Index::builder().set_unplaced_unmapped_record_count(21).build();
assert_eq!(index.unplaced_unmapped_record_count(), Some(21));

pub fn build(self) -> Index<I>

Builds a binning index.

Examples

use noodles_csi as csi;
let index = csi::Index::builder().build();

Trait Implementations

impl<I> Default for Builder<I>

fn default() -> Self

Returns the “default value” for a type.