Struct GenomicRange 

pub struct GenomicRange { /* private fields */ }

A genomic interval with explicit coordinate assumptions.

Implementations

impl GenomicRange

pub fn new( start: GenomicPosition, end: GenomicPosition, ) -> Result<GenomicRange, GenomicRangeError>

Creates a genomic range using zero-based half-open coordinates and unstranded orientation.

Errors

Returns GenomicRangeError::EndBeforeStart when end < start.

pub const fn with_strand(self, strand: Strand) -> GenomicRange

Sets the strand without changing positions.

pub fn with_coordinate_system( self, coordinate_system: CoordinateSystem, ) -> GenomicRange

Sets the coordinate system without converting positions.

pub const fn start(&self) -> GenomicPosition

Returns the start position.

pub const fn end(&self) -> GenomicPosition

Returns the end position.

pub const fn strand(&self) -> &Strand

Returns the strand.

pub const fn coordinate_system(&self) -> &CoordinateSystem

Returns the coordinate system.

pub const fn len(&self) -> u64

Returns the interval length according to the stored coordinate system.

No coordinate conversion is performed. For unknown and custom coordinate systems, the helper returns end - start after constructor validation.

pub const fn is_empty(&self) -> bool

Returns true when the coordinate-system-specific length is zero.

Trait Implementations

impl Clone for GenomicRange

fn clone(&self) -> GenomicRange

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GenomicRange

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

Formats the value using the given formatter.

impl PartialEq for GenomicRange

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

impl StructuralPartialEq for GenomicRange