Enum noodles_cram::record::feature::Feature

pub enum Feature {
    Bases(Position, Vec<u8>),
    Scores(Position, Vec<u8>),
    ReadBase(Position, u8, u8),
    Substitution(Position, Value),
    Insertion(Position, Vec<u8>),
    Deletion(Position, usize),
    InsertBase(Position, u8),
    QualityScore(Position, u8),
    ReferenceSkip(Position, usize),
    SoftClip(Position, Vec<u8>),
    Padding(Position, usize),
    HardClip(Position, usize),
}

A CRAM record feature.

Variants

Bases(Position, Vec<u8>)

A stretch of bases (position, bases).

Scores(Position, Vec<u8>)

A stretch of quality scores (position, quality scores).

ReadBase(Position, u8, u8)

A base-quality score pair (position, base, quality score).

Substitution(Position, Value)

A base substitution (position, code (read) / base (write)).

Insertion(Position, Vec<u8>)

Inserted bases (position, bases).

Deletion(Position, usize)

A number of deleted bases (position, length).

InsertBase(Position, u8)

A single inserted base (position, base).

QualityScore(Position, u8)

A single quality score (position, score).

ReferenceSkip(Position, usize)

A number of skipped bases (position, length).

SoftClip(Position, Vec<u8>)

Soft clipped bases (position, bases).

Padding(Position, usize)

A number of padded bases (position, length).

HardClip(Position, usize)

A number of hard clipped bases (position, length).

Implementations

impl Feature

pub fn code(&self) -> Code

Returns the feature code.

Examples

use noodles_core::Position;
use noodles_cram::record::{feature::Code, Feature};

let position = Position::try_from(8)?;
let feature = Feature::Padding(position, 13);

assert_eq!(feature.code(), Code::Padding);

pub fn position(&self) -> Position

Returns the feature position.

Examples

use noodles_core::Position;
use noodles_cram::record::Feature;

let position = Position::try_from(8)?;
let feature = Feature::Padding(position, 13);

assert_eq!(feature.position(), position);

Trait Implementations

impl Clone for Feature

fn clone(&self) -> Feature

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Feature

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

Formats the value using the given formatter.

impl PartialEq for Feature

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

impl StructuralPartialEq for Feature