Struct noodles_vcf::header::alternative_allele::AlternativeAllele

pub struct AlternativeAllele { /* fields omitted */ }

A VCF header symbolic alternate allele record (ALT).

Implementations

impl AlternativeAllele

pub fn new<D>(id: Symbol, description: D) -> Self where
    D: Into<String>, 

Creates a VCF header symbolic alternate allele.

Examples

use noodles_vcf::{
    header::AlternativeAllele,
    record::alternate_bases::allele::{
        symbol::{structural_variant::Type, StructuralVariant},
        Symbol,
    },
};

let alternative_allele = AlternativeAllele::new(
    Symbol::StructuralVariant(StructuralVariant::from(Type::Deletion)),
    "Deletion",
);

pub fn id(&self) -> &Symbol

Returns the alternate allele symbol.

Examples

use noodles_vcf::{
    header::AlternativeAllele,
    record::alternate_bases::allele::{
        symbol::{structural_variant::Type, StructuralVariant},
        Symbol,
    },
};

let alternative_allele = AlternativeAllele::new(
    Symbol::StructuralVariant(StructuralVariant::from(Type::Deletion)),
    "Deletion",
);

assert_eq!(
    alternative_allele.id(),
    &Symbol::StructuralVariant(StructuralVariant::from(Type::Deletion)),
);

pub fn description(&self) -> &str

Returns the description of the alternate allele symbol.

Examples

use noodles_vcf::{
    header::AlternativeAllele,
    record::alternate_bases::allele::{
        symbol::{structural_variant::Type, StructuralVariant},
        Symbol,
    },
};

let alternative_allele = AlternativeAllele::new(
    Symbol::StructuralVariant(StructuralVariant::from(Type::Deletion)),
    "Deletion",
);

assert_eq!(alternative_allele.description(), "Deletion");

Trait Implementations

impl Clone for AlternativeAllele

fn clone(&self) -> AlternativeAllele

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AlternativeAllele

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

Formats the value using the given formatter.

impl Display for AlternativeAllele

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

Formats the value using the given formatter.

impl PartialEq<AlternativeAllele> for AlternativeAllele

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

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

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

This method tests for !=.

impl TryFrom<Record> for AlternativeAllele

type Error = TryFromRecordError

The type returned in the event of a conversion error.

fn try_from(record: Record) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for AlternativeAllele

impl StructuralEq for AlternativeAllele

impl StructuralPartialEq for AlternativeAllele