Struct noodles::csi::index::Builder

pub struct Builder { /* fields omitted */ }

A coordinate-sorted index (CSI) builder.

Implementations

impl Builder

pub fn set_min_shift(self, min_shift: i32) -> Builder

Sets a min shift.

Examples

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

pub fn set_depth(self, depth: i32) -> Builder

Sets a max depth.

Examples

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

pub fn set_aux(self, aux: Vec<u8, Global>) -> Builder

Set auxiliary data.

Examples

use noodles_csi as csi;
let index = csi::Index::builder().set_aux(b"ndls".to_vec()).build();
assert_eq!(index.aux(), b"ndls");

pub fn set_reference_sequences(
    self,
    reference_sequences: Vec<ReferenceSequence, Global>
) -> Builder

Sets reference sequences.

Examples

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

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

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

pub fn set_n_no_coor(self, n_no_coor: u64) -> Builder

👎 Deprecated since 0.2.0:

Use set_unplaced_unmapped_record_count instead.

Sets an unmapped read count.

Examples

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

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

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

Builds a coordinate-sorted index (CSI).

Examples

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

Trait Implementations

impl Default for Builder

pub fn default() -> Builder

Returns the “default value” for a type.