Struct Allele 

#[non_exhaustive]
pub struct Allele<'a> {
    pub species: Species,
    pub gene: Cow<'a, Gene>,
    pub number: usize,
    pub sequence: &'a Peptidoform<UnAmbiguous>,
    pub regions: &'a [(Region, usize)],
    pub annotations: &'a [(Annotation, usize)],
}

A returned allele

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

species: Species

The species where this gene originates from

gene: Cow<'a, Gene>

The gene where this is the sequence for, eg IGHV3-23

number: usize

The allele number, in IMGT this follows the name, eg *01 is the allele in IGHV3-23*01

sequence: &'a Peptidoform<UnAmbiguous>

The actual sequence, the sequences present in the database are pure amino acids, no modifications are to be expected

regions: &'a [(Region, usize)]

The regions in the sequence, every region has an annotation and a length, all lengths together are the same length as the full sequence

annotations: &'a [(Annotation, usize)]

Any additional annotations, every annotation has beside the kind it is also its location, as index in the sequence

Implementations

impl Allele<'_>

pub fn name(&self) -> String

Get the IMGT name for this allele

pub fn fancy_name(&self) -> String

Get the biologists name for this allele with fancy non ASCII characters

Trait Implementations

impl AnnotatedPeptide for Allele<'_>

fn annotations(&self) -> &[(Annotation, usize)]

Get the annotations, specified as the annotation and the into the peptide where it is located.

fn regions(&self) -> &[(Region, usize)]

Get the regions, as a list of the regions in order with the length of each region, these are required to be as long as the full peptide.

fn get_region(&self, index: usize) -> Option<(&Region, bool)>

Get the region for a specific index into the sequence, None if outside range, the additional bool indicates if this is the starting position for the region.

fn get_annotations(&self, index: usize) -> impl Iterator<Item = &Annotation>

Get all annotations for this position

impl<'a> Clone for Allele<'a>

fn clone(&self) -> Allele<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Allele<'a>

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

Formats the value using the given formatter.

impl<'a> From<(Species, &'a Gene, usize, &'a AnnotatedSequence)> for Allele<'a>

fn from(value: (Species, &'a Gene, usize, &'a AnnotatedSequence)) -> Self

Converts to this type from the input type.

impl HasPeptidoformImpl for Allele<'_>

type Complexity = UnAmbiguous

The complexity level for this peptidoform containing structure

fn peptidoform(&self) -> &Peptidoform<Self::Complexity>

The peptidoform

impl<'a> PartialEq for Allele<'a>

fn eq(&self, other: &Allele<'a>) -> 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<'a> Eq for Allele<'a>

impl<'a> StructuralPartialEq for Allele<'a>