Struct noodles::vcf::variant::record_buf::samples::sample::value::genotype::allele::Allele

pub struct Allele { /* private fields */ }

A VCF record genotype value allele.

Implementations

impl Allele

pub fn new(position: Option<usize>, phasing: Phasing) -> Allele

Creates a variant record samples genotype value allele.

Examples

use noodles_vcf::variant::{
    record::samples::series::value::genotype::Phasing,
    record_buf::samples::sample::value::genotype::Allele,
};

let allele = Allele::new(Some(0), Phasing::Phased);

pub fn position(&self) -> Option<usize>

Returns the position of the allele.

Examples

use noodles_vcf::variant::{
    record::samples::series::value::genotype::Phasing,
    record_buf::samples::sample::value::genotype::Allele,
};

let allele = Allele::new(Some(0), Phasing::Phased);
assert_eq!(allele.position(), Some(0));

pub fn position_mut(&mut self) -> &mut Option<usize>

Returns a mutable reference to the position of the allele.

Examples

use noodles_vcf::variant::{
    record::samples::series::value::genotype::Phasing,
    record_buf::samples::sample::value::genotype::Allele,
};

let mut allele = Allele::new(Some(0), Phasing::Phased);
*allele.position_mut() = Some(1);
assert_eq!(allele.position(), Some(1));

pub fn phasing(&self) -> Phasing

Returns the phasing of the allele.

Examples

use noodles_vcf::variant::{
    record::samples::series::value::genotype::Phasing,
    record_buf::samples::sample::value::genotype::Allele,
};

let allele = Allele::new(Some(0), Phasing::Phased);
assert_eq!(allele.phasing(), Phasing::Phased);

pub fn phasing_mut(&mut self) -> &mut Phasing

Returns a mutable reference to the phasing of the allele.

Examples

use noodles_vcf::variant::{
    record::samples::series::value::genotype::Phasing,
    record_buf::samples::sample::value::genotype::Allele,
};

let mut allele = Allele::new(Some(0), Phasing::Phased);
*allele.phasing_mut() = Phasing::Unphased;
assert_eq!(allele.phasing(), Phasing::Unphased);

Trait Implementations

impl Clone for Allele

fn clone(&self) -> Allele

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Allele

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

Formats the value using the given formatter.

impl Extend<Allele> for Genotype

fn extend<T>(&mut self, iter: T)

where T: IntoIterator<Item = Allele>,

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<Allele> for Genotype

fn from_iter<T>(iter: T) -> Genotype

where T: IntoIterator<Item = Allele>,

Creates a value from an iterator.

impl FromStr for Allele

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Allele, <Allele as FromStr>::Err>

Parses a string s to return a value of this type.

impl PartialEq for Allele

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

impl StructuralPartialEq for Allele