Skip to main content

Genotype

Struct Genotype 

Source
pub struct Genotype { /* private fields */ }
Expand description

A parsed genotype for a single sample at a variant site.

Alleles are 0-indexed where 0 means reference and 1+ means the Nth alternate allele. None represents a missing allele (. in VCF).

Implementations§

Source§

impl Genotype

Source

pub fn parse(gt: &str) -> Result<Self>

Parse a VCF GT field string (e.g. "0/1", "1|0", "0|1|2", "./.", "0").

Returns the parsed genotype with allele indices and phasing information.

§Errors

Returns an error if the GT string is empty or contains invalid allele values.

Source

pub fn alleles(&self) -> &[Option<usize>]

Return the allele indices (one per haplotype).

Source

pub fn is_phased(&self) -> bool

Return whether this genotype is phased.

Source

pub fn ploidy(&self) -> usize

Return the ploidy (number of allele slots) at this site.

Source

pub fn has_alt(&self) -> bool

Return true if any allele is non-reference (index > 0).

Source

pub fn is_hom_alt(&self) -> bool

Return true if all alleles are the same non-reference allele.

Source

pub fn is_hom_ref(&self) -> bool

Return true if all alleles are reference (index 0).

Trait Implementations§

Source§

impl Clone for Genotype

Source§

fn clone(&self) -> Genotype

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Genotype

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for Genotype

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for Genotype

Source§

impl StructuralPartialEq for Genotype

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V