Skip to main content

Variant

Struct Variant 

Source
pub struct Variant {
    pub chrom: String,
    pub position: u64,
    pub id: Option<String>,
    pub ref_allele: Vec<u8>,
    pub alt_alleles: Vec<Vec<u8>>,
    pub quality: Option<f64>,
    pub filter: VariantFilter,
}
Expand description

A genomic variant (VCF-style representation).

Position is 1-based following VCF convention.

Fields§

§chrom: String§position: u64

1-based position (VCF convention).

§id: Option<String>

Optional identifier (e.g. rs12345).

§ref_allele: Vec<u8>

Reference allele.

§alt_alleles: Vec<Vec<u8>>

Alternate alleles.

§quality: Option<f64>

Phred-scaled quality score.

§filter: VariantFilter

Filter status.

Implementations§

Source§

impl Variant

Source

pub fn new( chrom: impl Into<String>, position: u64, ref_allele: Vec<u8>, alt_alleles: Vec<Vec<u8>>, ) -> Result<Self>

Create a new variant with minimal fields.

Validates that reference and alternate alleles are non-empty.

Source

pub fn variant_type(&self) -> VariantType

Infer the variant type from the first alternate allele.

Source

pub fn is_snv(&self) -> bool

Whether this is a single-nucleotide variant.

Source

pub fn is_indel(&self) -> bool

Whether this is an insertion or deletion.

Source

pub fn is_transition(&self) -> bool

Whether this SNV is a transition (A↔G or C↔T).

Returns false for non-SNV variants.

Source

pub fn is_transversion(&self) -> bool

Whether this SNV is a transversion (complement of transition for SNVs).

Returns false for non-SNV variants.

Source

pub fn to_genomic_interval(&self) -> GenomicInterval

Convert the 1-based VCF position to a 0-based GenomicInterval.

The interval spans the reference allele.

Trait Implementations§

Source§

impl Annotated for Variant

Source§

fn name(&self) -> &str

A human-readable name or identifier.
Source§

fn description(&self) -> Option<&str>

An optional description.
Source§

impl Clone for Variant

Source§

fn clone(&self) -> Variant

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 Variant

Source§

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

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

impl Scored for Variant

Source§

fn score(&self) -> f64

The score value.

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> Same for T

Source§

type Output = T

Should always be Self
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.