Enum bio_types::strand::Strand

pub enum Strand {
    Forward,
    Reverse,
    Unknown,
}

Strand information.

Variants

Forward

Reverse

Unknown

Implementations

impl Strand

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

Returns a Strand enum representing the given char.

The mapping is as follows: * '+', 'f', or 'F' becomes Strand::Forward * '-', 'r', or 'R' becomes Strand::Reverse * '.', '?' becomes Strand::Unknown * 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 +, the reverse strand is -, and unknown or unspecified strands are ..

pub fn is_unknown(&self) -> bool

Trait Implementations

impl Clone for Strand

fn clone(&self) -> Strand

Returns a copy 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 From<NoStrand> for Strand

fn from(_: NoStrand) -> Self

Performs the conversion.

impl From<Option<ReqStrand>> for Strand

fn from(orstr: Option<ReqStrand>) -> Self

Performs the conversion.

impl From<ReqStrand> for Strand

fn from(rstr: ReqStrand) -> Self

Performs the conversion.

impl From<Strand> for Option<ReqStrand>

fn from(strand: Strand) -> Option<ReqStrand>

Performs the conversion.

impl FromStr for Strand

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 Neg for Strand

type Output = Strand

The resulting type after applying the - operator.

fn neg(self) -> Strand

Performs the unary - operation.

impl PartialEq<Strand> for Strand

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

Returns true if both are Forward or both are Reverse, otherwise returns false.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Same for Strand

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

Indicate when two strands are the "same" -- two unknown/unspecified strands are the "same" but are not equal.