Enum Kind

pub enum Kind {
    Match,
    Insertion,
    Deletion,
    Skip,
    SoftClip,
    HardClip,
    Pad,
    SequenceMatch,
    SequenceMismatch,
}

An alignment record CIGAR operation kind.

Variants

Match

An alignment match (M).

Insertion

An insertion into the reference (I).

Deletion

A deletion from the reference (D).

Skip

A skipped region from the reference (N).

SoftClip

A soft clip (S).

HardClip

A hard clip (H).

Pad

Padding (P).

SequenceMatch

A sequence match (=).

SequenceMismatch

A sequence mismatch (X).

Implementations

impl Kind

pub fn consumes_read(&self) -> bool

Returns whether the operation kind causes the alignment to consume the read.

Examples

use noodles_sam::alignment::record::cigar::op::Kind;
assert!(Kind::Match.consumes_read());
assert!(Kind::Insertion.consumes_read());
assert!(!Kind::Deletion.consumes_read());

pub fn consumes_reference(&self) -> bool

Returns whether the operation kind causes the alignment to consume the reference.

Examples

use noodles_sam::alignment::record::cigar::op::Kind;
assert!(Kind::Match.consumes_reference());
assert!(!Kind::Insertion.consumes_reference());
assert!(Kind::Deletion.consumes_reference());

Trait Implementations

impl Clone for Kind

fn clone(&self) -> Kind

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Kind

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

Formats the value using the given formatter.

impl PartialEq for Kind

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Kind

impl Eq for Kind

impl StructuralPartialEq for Kind