Struct Bin

pub struct Bin { /* private fields */ }

A binning index reference sequence bin.

Implementations

impl Bin

pub const fn max_id(depth: u8) -> usize

Calculates the maximum bin ID.

Examples

use noodles_csi::binning_index::index::reference_sequence::Bin;
assert_eq!(Bin::max_id(5), 37449);

pub const fn metadata_id(depth: u8) -> usize

Calculates the metadata bin ID.

Examples

use noodles_csi::binning_index::index::reference_sequence::Bin;
assert_eq!(Bin::metadata_id(5), 37450);

pub fn new(chunks: Vec<Chunk>) -> Self

Creates a binning index reference sequence bin.

Examples

use noodles_csi::binning_index::index::reference_sequence::Bin;
let bin = Bin::new(Vec::new());

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

Returns the list of chunks in the bin.

Examples

use noodles_bgzf as bgzf;
use noodles_csi::binning_index::index::reference_sequence::Bin;
let bin = Bin::new(Vec::new());
assert!(bin.chunks().is_empty());

pub fn add_chunk(&mut self, chunk: Chunk)

Adds or merges a chunk.

Trait Implementations

impl Clone for Bin

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

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

Formats the value using the given formatter.

impl PartialEq for Bin

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Bin

impl StructuralPartialEq for Bin