Skip to main content

GenomicRange

Struct GenomicRange 

Source
pub struct GenomicRange { /* private fields */ }
Expand description

A genomic interval with explicit coordinate assumptions.

Implementations§

Source§

impl GenomicRange

Source

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

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

§Errors

Returns GenomicRangeError::EndBeforeStart when end < start.

Source

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

Sets the strand without changing positions.

Source

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

Sets the coordinate system without converting positions.

Source

pub const fn start(&self) -> GenomicPosition

Returns the start position.

Source

pub const fn end(&self) -> GenomicPosition

Returns the end position.

Source

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

Returns the strand.

Source

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

Returns the coordinate system.

Source

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.

Source

pub const fn is_empty(&self) -> bool

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

Trait Implementations§

Source§

impl Clone for GenomicRange

Source§

fn clone(&self) -> GenomicRange

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for GenomicRange

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for GenomicRange

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl Eq for GenomicRange

Source§

impl StructuralPartialEq for GenomicRange

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.