Enum bio_types::strand::ReqStrand

pub enum ReqStrand {
    Forward,
    Reverse,
}

Strand information for annotations that require a strand.

Variants

Forward

Reverse

Implementations

impl ReqStrand

pub fn from_char(strand_char: &char) -> Result<ReqStrand, StrandError>

Returns a ReqStrand enum representing the given char.

The mapping is as follows: * ‘+’, ‘f’, or ‘F’ becomes Strand::Forward * ‘-’, ‘r’, or ‘R’ becomes Strand::Reverse * Any other inputs will return an Err(StrandError::InvalidChar)

pub fn strand_symbol(&self) -> &str

Symbol denoting the strand. By convention, in BED and GFF files, the forward strand is + and the reverse strand is -.

pub fn on_strand<T>(&self, x: T) -> T where
    T: Neg<Output = T>, 

Convert the (optional) strand of some other annotation according to this strand. That is, reverse the strand of the other annotation for ReqStrand::Reverse and leave it unchanged for ReqStrand::Forward.

Arguments

• x is the strand information from some other annotation.

use bio_types::strand::{ReqStrand,Strand};
assert_eq!(ReqStrand::Forward.on_strand(Strand::Reverse),
           ReqStrand::Reverse.on_strand(Strand::Forward));

Trait Implementations

impl Clone for ReqStrand

fn clone(&self) -> ReqStrand

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ReqStrand

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

Formats the value using the given formatter.

impl Display for ReqStrand

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

Formats the value using the given formatter.

impl From<ReqStrand> for Strand

fn from(rstr: ReqStrand) -> Self

Converts to this type from the input type.

impl FromStr for ReqStrand

type Err = StrandError

The associated error which can be returned from parsing.

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

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

impl Hash for ReqStrand

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Neg for ReqStrand

type Output = ReqStrand

The resulting type after applying the - operator.

fn neg(self) -> ReqStrand

Performs the unary - operation.

impl Ord for ReqStrand

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<ReqStrand> for ReqStrand

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<ReqStrand> for ReqStrand

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Same for ReqStrand

fn same(&self, s1: &Self) -> bool

Indicate when two strands are the “same” – two unknown/unspecified strands are the “same” but are not equal.

impl Copy for ReqStrand

impl Eq for ReqStrand

impl StructuralEq for ReqStrand

impl StructuralPartialEq for ReqStrand