Enum Strand 

#[repr(u8)]
pub enum Strand {
    Positive = 0,
    Negative = 1,
}

The strand of a double-stranded molecule.

For a more in-depth discussion on this, please see this section of the docs.

Variants

Positive = 0

The positive strand (+).

This is also known as the sense strand.

Negative = 1

The negative strand (-).

This is also known as the antisense strand.

Implementations

impl Strand

pub fn complement(&self) -> Strand

Complements a strand.

Examples

use omics_coordinate::Strand;

assert_eq!(Strand::Positive.complement(), Strand::Negative);
assert_eq!(Strand::Negative.complement(), Strand::Positive);

Trait Implementations

impl Clone for Strand

fn clone(&self) -> Strand

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Strand

impl Debug for Strand

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

Formats the value using the given formatter.

impl Display for Strand

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

Formats the value using the given formatter.

impl Eq for Strand

impl FromStr for Strand

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self>

Parses a string s to return a value of this type.

impl Ord for Strand

fn cmp(&self, other: &Strand) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Strand

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

fn partial_cmp(&self, other: &Strand) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for Strand

impl TryFrom<&str> for Strand

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.