Struct rustyms::imgt::Selection

pub struct Selection {
    pub species: Option<HashSet<Species>>,
    pub chains: Option<HashSet<ChainType>>,
    pub genes: Option<HashSet<GeneType>>,
    pub allele: AlleleSelection,
}

The selection rules for iterating over a selection of germlines.

Fields

species: Option<HashSet<Species>>

The species you want, None allows all, otherwise only the species specified will be returned

chains: Option<HashSet<ChainType>>

The chain of genes you want, None allows all, otherwise only the chains specified will be returned

genes: Option<HashSet<GeneType>>

The kind of genes you want, None allows all, otherwise only the genes specified will be returned

allele: AlleleSelection

The way of handling alleles you want

Implementations

impl Selection

pub fn species(self, species: impl Into<HashSet<Species>>) -> Self

Builder pattern method to add a species selection, will replace any previously set species selection

pub fn chain(self, chains: impl Into<HashSet<ChainType>>) -> Self

Builder pattern method to add a chain selection, will replace any previously set chain selection

pub fn gene(self, genes: impl Into<HashSet<GeneType>>) -> Self

Builder pattern method to add a gene selection, will replace any previously set gene selection

pub fn allele(self, allele: AlleleSelection) -> Self

Builder pattern method to add an allele selection, will replace any previously set allele selection

pub fn germlines(self) -> impl Iterator<Item = Allele<'static>>

Get the selected alleles

pub fn par_germlines(self) -> impl ParallelIterator<Item = Allele<'static>>

Get the selected alleles in parallel fashion, only available if you enable the feature “rayon” (on by default)

Trait Implementations

impl Clone for Selection

fn clone(&self) -> Selection

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Selection

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

Formats the value using the given formatter.

impl Default for Selection

fn default() -> Self

Get a default selection, which gives all kinds and genes but only returns the first allele

impl PartialEq for Selection

fn eq(&self, other: &Selection) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Selection

impl StructuralPartialEq for Selection