Skip to main content

HgvsVariant

Struct HgvsVariant 

Source
pub struct HgvsVariant {
    pub reference: Option<ReferenceSpec>,
    pub coordinate_system: CoordinateSystem,
    pub description: VariantDescription,
}
Expand description

A parsed HGVS variant.

This is the root model returned by crate::parse_hgvs. It keeps the reference, coordinate system, and biological description together.

§Examples

use tinyhgvs::{CoordinateSystem, VariantDescription, parse_hgvs};

let variant = parse_hgvs("NM_007373.4:c.-1C>T").unwrap();
assert_eq!(variant.coordinate_system, CoordinateSystem::CodingDna);

match variant.description {
    VariantDescription::Nucleotide(description) => {
        assert_eq!(description.location.start.coordinate, -1);
    }
    VariantDescription::Protein(_) => unreachable!("expected nucleotide variant"),
}

Fields§

§reference: Option<ReferenceSpec>

Reference sequence metadata such as NM_004006.2. Optional for shorthand protein variants such as p.Gly2_Met46del.

§coordinate_system: CoordinateSystem

HGVS coordinate type such as c, g, r, or p.

§description: VariantDescription

Parsed variant description for nucleotide or protein syntax.

Trait Implementations§

Source§

impl Clone for HgvsVariant

Source§

fn clone(&self) -> HgvsVariant

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 HgvsVariant

Source§

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

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

impl PartialEq for HgvsVariant

Source§

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

Source§

impl StructuralPartialEq for HgvsVariant

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<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.