Struct noodles::vcf::record::Genotype

pub struct Genotype(_);

A VCF record genotype.

Implementations

impl Genotype

pub fn from_str_format(s: &str, format: &Format) -> Result<Genotype, ParseError>

Parses a raw genotype for the given genotype format.

Examples

use std::convert::TryFrom;
use noodles_vcf::record::{genotype::{field::{Key, Value}, Field}, Genotype};

let format = "GT:GQ".parse()?;

assert_eq!(
    Genotype::from_str_format("0|0:13", &format),
    Ok(Genotype::try_from(vec![
        Field::new(Key::Genotype, Some(Value::String(String::from("0|0")))),
        Field::new(Key::ConditionalGenotypeQuality, Some(Value::Integer(13))),
    ])?)
);

Methods from Deref<Target = IndexMap<Key, Field, RandomState>>

pub fn capacity(&self) -> usize

Computes in O(1) time.

pub fn hasher(&self) -> &S

Return a reference to the map’s BuildHasher.

pub fn len(&self) -> usize

Return the number of key-value pairs in the map.

Computes in O(1) time.

pub fn is_empty(&self) -> bool

Returns true if the map contains no elements.

Computes in O(1) time.

pub fn iter(&self) -> Iter<'_, K, V>

Return an iterator over the key-value pairs of the map, in their order

pub fn keys(&self) -> Keys<'_, K, V>

Return an iterator over the keys of the map, in their order

pub fn values(&self) -> Values<'_, K, V>

Return an iterator over the values of the map, in their order

pub fn contains_key<Q>(&self, key: &Q) -> bool where
    Q: Hash + Equivalent<K> + ?Sized, 

Return true if an equivalent to key exists in the map.

Computes in O(1) time (average).

pub fn get<Q>(&self, key: &Q) -> Option<&V> where
    Q: Hash + Equivalent<K> + ?Sized, 

Return a reference to the value stored for key, if it is present, else None.

Computes in O(1) time (average).

pub fn get_key_value<Q>(&self, key: &Q) -> Option<(&K, &V)> where
    Q: Hash + Equivalent<K> + ?Sized, 

Return references to the key-value pair stored for key, if it is present, else None.

Computes in O(1) time (average).

pub fn get_full<Q>(&self, key: &Q) -> Option<(usize, &K, &V)> where
    Q: Hash + Equivalent<K> + ?Sized, 

Return item index, key and value

pub fn get_index_of<Q>(&self, key: &Q) -> Option<usize> where
    Q: Hash + Equivalent<K> + ?Sized, 

Return item index, if it exists in the map

Computes in O(1) time (average).

pub fn get_index(&self, index: usize) -> Option<(&K, &V)>

Get a key-value pair by index

Valid indices are 0 <= index < self.len()

Computes in O(1) time.

pub fn first(&self) -> Option<(&K, &V)>

Get the first key-value pair

Computes in O(1) time.

pub fn last(&self) -> Option<(&K, &V)>

Get the last key-value pair

Computes in O(1) time.

Trait Implementations

impl Clone for Genotype

pub fn clone(&self) -> Genotype

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Genotype

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

Formats the value using the given formatter.

impl Default for Genotype

pub fn default() -> Genotype

Returns the “default value” for a type.

impl Deref for Genotype

type Target = IndexMap<Key, Field, RandomState>

The resulting type after dereferencing.

pub fn deref(&self) -> &<Genotype as Deref>::Target

Dereferences the value.

impl Display for Genotype

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

Formats the value using the given formatter.

impl PartialEq<Genotype> for Genotype

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl TryFrom<Vec<Field, Global>> for Genotype

type Error = TryFromFieldsError

The type returned in the event of a conversion error.

pub fn try_from(
    fields: Vec<Field, Global>
) -> Result<Genotype, <Genotype as TryFrom<Vec<Field, Global>>>::Error>

Performs the conversion.

impl StructuralPartialEq for Genotype