Struct Selection 

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

The selection rules for iterating over a selection of germlines.

Fields

species: Option<HashSet<Species, S1>>

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

chains: Option<HashSet<ChainType, S2>>

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<S1: BuildHasher, S2: BuildHasher> Selection<S1, S2>

pub fn species(self, species: impl Into<HashSet<Species, S1>>) -> 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, S2>>) -> 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

impl<'a, S1: BuildHasher + Clone + Send + Sync + 'a, S2: BuildHasher + Clone + Send + Sync + 'a> Selection<S1, S2>

pub fn germlines( self, cv: &'a CVIndex<IMGT>, ) -> impl Iterator<Item = Allele<'a>>

Get the selected alleles

pub fn par_germlines( self, cv: &'a CVIndex<IMGT>, ) -> impl ParallelIterator<Item = Allele<'a>>

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

Trait Implementations

impl<S1: Clone + BuildHasher, S2: Clone + BuildHasher> Clone for Selection<S1, S2>

fn clone(&self) -> Selection<S1, S2>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S1: Debug + BuildHasher, S2: Debug + BuildHasher> Debug for Selection<S1, S2>

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

Formats the value using the given formatter.

impl<S1: BuildHasher, S2: BuildHasher> Default for Selection<S1, S2>

fn default() -> Self

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

impl<S1: PartialEq + BuildHasher, S2: PartialEq + BuildHasher> PartialEq for Selection<S1, S2>

fn eq(&self, other: &Selection<S1, S2>) -> 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<S1: Eq + BuildHasher, S2: Eq + BuildHasher> Eq for Selection<S1, S2>

impl<S1: BuildHasher, S2: BuildHasher> StructuralPartialEq for Selection<S1, S2>