Struct noodles::bam::bai::index::reference_sequence::Bin

pub struct Bin { /* fields omitted */ }

A bin in a BAM index reference sequence.

Bin numbers have an effective range between 0 and 37449, inclusive. An optional pseudo-bin at bin number 37450 holds two pairs of metadata: virtual positions of the start and end of the reference sequence and the number of mapped and unmapped reads in the reference sequence.

Implementations

impl Bin

pub fn new(id: u32, chunks: Vec<Chunk, Global>) -> Bin

Creates a BAM index reference sequence bin.

Examples

use noodles_bam::bai::index::reference_sequence::Bin;
let bin = Bin::new(10946, Vec::new());

pub fn id(&self) -> u32

Returns the bin ID.

This is also called the bin number.

Examples

use noodles_bam::bai::index::reference_sequence::Bin;
let bin = Bin::new(10946, Vec::new());
assert_eq!(bin.id(), 10946);

pub fn chunks(&self) -> &[Chunk]

Returns the list of chunks in the bin.

Examples

use noodles_bam::bai::index::reference_sequence::Bin;
let bin = Bin::new(10946, Vec::new());
assert!(bin.chunks().is_empty());

Trait Implementations

impl Clone for Bin

pub fn clone(&self) -> Bin

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Bin

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

Formats the value using the given formatter.

impl PartialEq<Bin> for Bin

pub fn eq(&self, other: &Bin) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &Bin) -> bool

This method tests for !=.

impl Eq for Bin

impl StructuralEq for Bin

impl StructuralPartialEq for Bin