Struct Gene 

pub struct Gene {
    pub chain: ChainType,
    pub kind: GeneType,
    pub number: Option<usize>,
    pub family: Vec<(Option<usize>, String)>,
}

A germline gene name, broken up in its constituent parts.

Fields

chain: ChainType

The chain of this gene (heavy/kappa etc)

kind: GeneType

The kind of gene (V/J/C)

number: Option<usize>

If present the additional number IGHV (I)

family: Vec<(Option<usize>, String)>

The family indicators IGHV -1D

Implementations

impl Gene

pub fn from_imgt_name_with_allele(s: &str) -> Result<(Self, usize), String>

Get an IMGT name with allele, eg IGHV3-23*03

Errors

If not recognised as a name, returns a description of the error.

pub fn from_imgt_name(s: &str) -> Result<Self, String>

Get an IMGT name, eg IGHV3-23

Errors

If not recognised as a name, returns a description of the error.

Trait Implementations

impl<'__de, __Context> BorrowDecode<'__de, __Context> for Gene

fn borrow_decode<__D: BorrowDecoder<'__de, Context = __Context>>( decoder: &mut __D, ) -> Result<Self, DecodeError>

Attempt to decode this type with the given BorrowDecode.

impl Clone for Gene

fn clone(&self) -> Gene

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Gene

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

Formats the value using the given formatter.

impl<__Context> Decode<__Context> for Gene

fn decode<__D: Decoder<Context = __Context>>( decoder: &mut __D, ) -> Result<Self, DecodeError>

Attempt to decode this type with the given Decode.

impl<'de> Deserialize<'de> for Gene

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Gene

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

Formats the value using the given formatter.

impl Encode for Gene

fn encode<__E: Encoder>(&self, encoder: &mut __E) -> Result<(), EncodeError>

Encode a given type.

impl FancyDisplay for Gene

fn to_fancy_string(&self) -> String

Equivalent of .to_string() but then fancier!

impl Hash for Gene

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Gene

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

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

fn partial_cmp(&self, other: &Gene) -> 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 Serialize for Gene

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Gene

impl StructuralPartialEq for Gene