Struct Chunk

pub struct Chunk { /* private fields */ }

An index reference sequence bin chunk.

A chunk is a range of virtual positions representing [start, end).

Implementations

impl Chunk

pub fn new(start: VirtualPosition, end: VirtualPosition) -> Self

Creates a new chunk.

Examples

use noodles_bgzf as bgzf;
use noodles_csi::binning_index::index::reference_sequence::bin::Chunk;
let chunk = Chunk::new(bgzf::VirtualPosition::from(8), bgzf::VirtualPosition::from(13));

pub fn start(&self) -> VirtualPosition

Returns the chunk start (inclusive) as a virtual position.

Examples

use noodles_bgzf as bgzf;
use noodles_csi::binning_index::index::reference_sequence::bin::Chunk;
let chunk = Chunk::new(bgzf::VirtualPosition::from(8), bgzf::VirtualPosition::from(13));
assert_eq!(chunk.start(), bgzf::VirtualPosition::from(8));

pub fn end(&self) -> VirtualPosition

Returns the chunk end (exclusive) as a virtual position.

Examples

use noodles_bgzf as bgzf;
use noodles_csi::binning_index::index::reference_sequence::bin::Chunk;
let chunk = Chunk::new(bgzf::VirtualPosition::from(8), bgzf::VirtualPosition::from(13));
assert_eq!(chunk.end(), bgzf::VirtualPosition::from(13));

Trait Implementations

impl Clone for Chunk

fn clone(&self) -> Chunk

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Chunk

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

Formats the value using the given formatter.

impl From<Range<VirtualPosition>> for Chunk

fn from(range: Range<VirtualPosition>) -> Self

Converts to this type from the input type.

impl PartialEq for Chunk

fn eq(&self, other: &Chunk) -> 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 Copy for Chunk

impl Eq for Chunk

impl StructuralPartialEq for Chunk